![]() If you need non-default options (for instance to use extra packages) you need to make a configuration file with those options set correctly and then specify that configuration file after the generated files (make a backup of the configuration file first so you don't loose it in case you forget to specify one of the output files).įor RTF output, you can generate the default style sheet file (see RTF_STYLESHEET_FILE) using: doxygen -w rtf rtfstyle.cfg When this is also not found it will used the default settings.įor output, you can generate the first and last part of refman.tex (see LATEX_HEADER and LATEX_FOOTER) and the style sheet included by that header (normally doxygen.sty), using the following command: doxygen -w latex header.tex footer.tex doxygen.sty When omitted doxygen will search for a file named Doxyfile and process that. If you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, and footer files that you can edit afterwards:įor HTML output, you can generate the default header file (see HTML_HEADER), the default footer (see HTML_FOOTER), and the default style sheet (see HTML_STYLESHEET), using the following command: doxygen -w html header.html footer.html stylesheet.css Note that comments that you may have added in the original configuration file will be lost. Any new options will have their default value. doxygen -u Īll configuration settings in the original configuration file will be copied to the new configuration file. If you have a configuration file generated with an older version of doxygen, you can upgrade it to the current version by running doxygen with the -u option. You let doxygen generate the documentation, based on the settings in the configuration file: doxygen In the configuration file you can specify the input files and a lot of optional information. You edit the configuration file so it matches your project. You generate a configuration file (see section Configuration) by calling doxygen with the -g option: doxygen -g You document your source code with special documentation blocks (see section Special comment blocks). To generate a manual for your project you typically need to follow these steps: Calling doxygen with the -help option at the command line will give you a brief description of the usage of the program.Īll options consist of a leading character -, followed by one character and one or more arguments depending on the option. ![]() The doxygen.js filter uses the \\\ style before functions and namespaces as in the following example: /// Sync.Doxygen is a command line based utility. Where doxygen.js must be the path to the desired javascript filter.įind the FILE_PATTERNS control tag and include *.js among the terminations listed.Ĭhange the INPUT tag to point to your source folder.įinally, comment the js file using the patterns suitable to the filter. But you can choose to develop your own filter.Īfter you choose your filter you need to change your Doxygen config file to find and process javascript files.įind the FILE_PATTERNS control tag in your original config file and adjust its value: If you choose to use that link's filter, you will need node.js installed in order to run it. You should find help in the filter at this link: The Doxygen manual cites as a Perl script to help in js documentation but also alerts that the original author's page is currently unachievable. You can maintain your workflow with Doxygen and still document javascript files using a proper filter and minor changes in your configuration file. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |