Skip to content

Commit db42866

Browse files
authored
Merge pull request #3029 from randombit/fix/sphinx_warnings
Fix: Sphinx warnings
2 parents 7ba63f9 + ccab35a commit db42866

2 files changed

Lines changed: 6 additions & 9 deletions

File tree

doc/api_ref/pkcs11.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Getting started
116116

117117
An object of this class can be instantiated by providing a :cpp:type:`FunctionListPtr` to the :cpp:class:`LowLevel` constructor:
118118

119-
.. cpp:function:: explicit LowLevel(FunctionListPtr ptr)
119+
.. cpp:function:: explicit LowLevel::LowLevel(FunctionListPtr ptr)
120120

121121
The :cpp:class:`LowLevel` class provides a static method to retrieve a :cpp:type:`FunctionListPtr`
122122
from a PKCS#11 module file:
@@ -462,7 +462,7 @@ This class represents the common attributes of all PKCS#11 objects.
462462

463463
The constructor is defined as follows:
464464

465-
.. cpp:function:: ObjectProperties(ObjectClass object_class)
465+
.. cpp:function:: ObjectProperties::ObjectProperties(ObjectClass object_class)
466466

467467
Every PKCS#11 object needs an object class attribute.
468468

@@ -474,7 +474,7 @@ The next level defines the :cpp:class:`StorageObjectProperties` class which inhe
474474
The only mandatory attribute is the object class, so the constructor is
475475
defined as follows:
476476

477-
.. cpp:function:: StorageObjectProperties(ObjectClass object_class)
477+
.. cpp:function:: StorageObjectProperties::StorageObjectProperties(ObjectClass object_class)
478478

479479
But in contrast to the :cpp:class:`ObjectProperties` class there are various setter methods. For example to
480480
set the :cpp:enumerator:`AttributeType::Label`:
@@ -499,11 +499,11 @@ PKCS#11 objects themselves are represented by the :cpp:class:`Object` class.
499499

500500
Following constructors are defined:
501501

502-
.. cpp:function:: Object(Session& session, ObjectHandle handle)
502+
.. cpp:function:: Object::Object(Session& session, ObjectHandle handle)
503503

504504
Takes ownership over an existing object.
505505

506-
.. cpp:function:: Object(Session& session, const ObjectProperties& obj_props)
506+
.. cpp:function:: Object::Object(Session& session, const ObjectProperties& obj_props)
507507

508508
Creates a new object with the :cpp:class:`ObjectProperties` provided in ``obj_props``.
509509

@@ -557,7 +557,7 @@ and :cpp:func:`C_FindObjectsFinal`.
557557

558558
The constructor has the following signature:
559559

560-
.. cpp:function:: ObjectFinder(Session& session, const std::vector<Attribute>& search_template)
560+
.. cpp:function:: ObjectFinder::ObjectFinder(Session& session, const std::vector<Attribute>& search_template)
561561

562562
A search can be prepared with an :cpp:class:`ObjectSearcher` by passing a :cpp:class:`Session` and a ``search_template``.
563563

doc/api_ref/threads.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)