# this must be arranged in ascending order. # this must be arranged in ascending order ( otherwise '#' would match before '#<'). If self.external_cmd: # Multiline external command Tmp = line.split(self.relatedEndComment, 1) If self.relatedEndComment != "": # for single-line comments save nothing more. If self.has_endCommit(line): # Save end-comment sign and the rest of the line Self.external_cmd = None # reset external-marker Output_line = output_line + tmp # save everything between and = tmp # proceed with substring behind end_external Tmp = line.split(self.external_end_cmd, 1) If self.external_cmd is not None and self.has_endExternal(line): # If is active, and is in line If self.has_external(line): # Substring contains = line.split(self.external_cmd, 1) # extract everything after that. If self.prevComment is not None: # Edit only commit lines Line = tmp # proceed with everything behind comment-sign Output_line = tmp + self.prevComment # Save beginning through comment-sign Tmp = input_line.split(self.prevComment, 1) If self.prevComment is None and self.get_comment_start(line): # Commit starts If self.relatedEndComment is not None and self.relatedEndComment in line: # Comment signs must be arranged in ascending order PythonParserįor commentPattern in ment_start: """ Parser to detect and in source code comments and only extract the content between. # Copyright © 2023 Mahr GmbH, author Jan Stietenroth Input filter script: external_parser.py #!/usr/bin/env python (replace the external command by space-character.) ALIASES = "external= "\ external_parser.py"Ĭhanges in the doxyfile for internal documentation: The input filter discards every comment line from the applied file, except it has an or tag (\external \end_external is also OK).Ĭhanges in doxyfile for external documentation: HIDE_UNDOC_MEMBERS = YES To use this, you need to do a few changes in the doxyfile. Here is a parser / filter-script that does the required work, hoping it will help someone. The external documentation should only contain the page public documentation and the documentation of func(). You can call the function func(), the rest is top secret internal stuff Is there any smart way to do this with conditional documentation ( the moment it is also not so easy to filter the input files by name or path and use only some. Is there any possibility to do this, without marking everything with the command? I am looking for the opposite command. However, for customers I will create a documentation about a few functions and pages (like creating an API documentation, but hiding everything behind). Most of the functions and classes are internal. Is there any possibility to exclude all documented functions, classes, pages from the output, except those who are specially labelled?
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |