Add a custom Doxygen command to notfy wrapper generators to do not wrap functions or structs

This commit is contained in:
François Grisez 2017-03-27 17:36:55 +02:00
parent bdde8f8802
commit 33d7528c13
3 changed files with 15 additions and 2 deletions

View file

@ -228,7 +228,8 @@ TAB_SIZE = 8
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES = "bctbx_list{1}=A list of \ref \1 objects. \xmlonly <bctbxlist>\1</bctbxlist> \endxmlonly"
ALIASES = bctbx_list{1}="A list of \ref \1 objects. \xmlonly <bctbxlist>\1</bctbxlist> \endxmlonly"
ALIASES += donotwrap="\xmlonly <donotwrap /> \endxmlonly"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"

View file

@ -304,6 +304,9 @@ class Project:
descriptionNode.tag = 'description'
descriptionNode.attrib = {}
return descriptionNode
def __canBeWrapped(self, node):
return node.find('./detaileddescription//donotwrap') is None
def __discoverClasses(self):
for td in self.__typedefs:
@ -491,6 +494,8 @@ class Project:
self.add(td)
def __parseCFunctionMemberdef(self, node):
if not Project.__canBeWrapped(self, node):
return None
internal = node.find("./detaileddescription/internal")
if internal is not None:
return None

View file

@ -22,7 +22,14 @@
add_custom_command(OUTPUT include/linphone++/linphone.hh src/linphone++.cc
COMMAND ${PYTHON_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/genwrapper.py" "${PROJECT_BINARY_DIR}/coreapi/help/doc/xml"
DEPENDS abstractapi.py genwrapper.py class_header.mustache class_impl.mustache enums_header.mustache main_header.mustache linphone-doc
DEPENDS ${PROJECT_SOURCE_DIR}/tools/genapixml.py
abstractapi.py
genwrapper.py
class_header.mustache
class_impl.mustache
enums_header.mustache
main_header.mustache
linphone-doc
"${PROJECT_BINARY_DIR}/coreapi/help/doc/xml/index.xml"
)