multidoc.error

exception multidoc.error.ClassNotDeclaredError

Class not declared in API Declaration.

exception multidoc.error.FunctionNotDeclaredError

Function not declared in API Declaration.

exception multidoc.error.MethodNotDeclaredError

Method not declared in API Declaration.

Examples

example-1.yaml

 classes:
   - name: ExampleClass
     methods:
       - name: constructor
       - name: foo_method
       # there is no bar_method !

ExampleClass.hpp

#include <string>

//! @get_docstring(ExampleClass.__docstring__)
class ExampleClass {
public:

   //! @get_docstring(ExampleClass.constructor)
   ExampleClass();

   //! @get_docstring(ExampleClass.foo_method)
   std::string foo_method();

   //! @get_docstring(ExampleClass.bar_method)
   std::string bar_method();

}

>>> from multidoc.parsing import parse_api_declaration
>>> from multidoc.testing import TESTING_DIR
>>> import os
>>> s = parse_api_declaration(os.path.join(TESTING_DIR, "example-1.yaml"))

exception multidoc.error.OverloadNotFoundError

Overload not declared in API Declaration.