diff --git a/Doxyfile b/Doxyfile index da05018beafe7c35c5f9cc6e191f59712b4b3abf..1569ea41cc1942e92be992ef3a00750083ff8cda 100644 --- a/Doxyfile +++ b/Doxyfile @@ -499,7 +499,7 @@ NUM_PROC_THREADS = 1 # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -908,7 +908,8 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = include +INPUT = include \ + interface/CPP # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -993,7 +994,8 @@ FILE_PATTERNS = *.c \ *.vhdl \ *.ucf \ *.qsf \ - *.ice + *.ice \ + *.cxx # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -2322,7 +2324,7 @@ ENABLE_PREPROCESSING = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # the macro expansion is limited to the macros specified with the PREDEFINED and diff --git a/doc/source/cpp/index.rst b/doc/source/cpp/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..1be428aa8b004fa2ab38c736704ff8e74ea33928 --- /dev/null +++ b/doc/source/cpp/index.rst @@ -0,0 +1,9 @@ +C++ interface +=============== + +Introduction +------------ + +The abstract base class defining the public C++ interface of teqp is documented in :teqp:`AbstractModel`. This interface was developed because re-compilation of the core of ``teqp`` is VERY slow, due to the heavy use of templates, which makes the code very flexible, but difficult to work with when doing development. Especially users that would like to only use the library but not be forced to pay the price of recompilation benefit from this approach. + +The models that are allowed in this abstract interface are defined in :teqp:`AllowedModels`. A new model instance can be created by passing properly formatted JSON data structure to the :teqp:`make_model` function. \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 24647d13d13a1df845ba126413214df385976cc2..3331d72969a0aff0ef36b5682b8ea5b56d744e18 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,6 +6,7 @@ Welcome to teqp's documentation! :caption: Contents: getting_started/index + cpp/index models/index derivs/index algorithms/index