Second, add the directory that will contain your image to the docs/Images/ directory. As most images will be diagrammatical in nature this is certainly achievable! Include any pictures that aid in the understanding of your documentation:įirst, please compress your image to be under 130kB. ![]() It will also show a popover when hovering over the link, which displays the bibliographic information and provides quick access to the publication. It will render as a numbered link to the bibliography page. To cite an entry from the docs/References.bib file in the documentation, use the Doxygen keyword \citeįollowed by the BibTeX key at the place in the documentation where you want the citation to appear. Prevents ClangFormat from changing the code to word word word \f when capitalization is important, or when BibTeX keywords should be ignored (e.g. When using out-of-line equations it is important to have a blank Doxygen line above and below the equation so that ClangFormat does not merge the equation with other lines. See the texfaq for an explanation as to why. Please prefer the align environment over the eqnarray environment. We also encourage you to use the latex env align for formatting these multiple-line equations. One can also use (within a Doxygen comment) the form \f Note that if this expression spans more than one line, your Doxygen comment must of the "slash-star, star-slash" form shown in the previous section. Within a Doxygen comment, begin and conclude your expression with \f$Įxample: \\\ We define \f$ \xi : = \eta^2 \f$ ![]() Put any mathematical expressions in your documentation into LaTeX form: Subsequent files which use this namespace will not need a Doxygen comment. In the hpp file in which the namespace is declared for the first time, add a Doxygen comment to the line directly above the namespace. Within docs/GroupDefs.hpp, add the name of your Module (which follows the naming convention "YourNameForModule" followed by "Group") among the rest, taking care to keep the list of Modules in alphabetical order. Within a Doxygen comment, use the Doxygen keyword \ingroupįollowed by the name of the Module (you can find the list of existing Modules in docs/GroupDefs.hpp). Note The /// Doxygen syntax does not require a \brief, while the C-style /*! does. To ensure that your documentation is easily found from within Doxygen, we recommend that you add any new objects to Modules and any new namespaces to Namespaces. In addition to providing a file directory of all the source files in SpECTRE, Doxygen also conveniently provides two additional organizations of the files, Modules and Namespaces. You can then view it by opening BUILD_DIR/docs/html/index.html in a browser and using the file navigator in Doxygen to locate your file. * using the "slash-star, star-slash" pattern, in this way.īuild your documentation by running make doc in your build directory. * \brief A brief description of the object to be documented We require you to add Doxygen documentation for any of the following you may have added to the public interface in any hpp file:ĭocumentation begins on the line immediately above the declaration with either a triple slash /// or a /*!.Įxamples: /// A brief description of the object to be documented are shown in the table of contents if they have a tag, if not they do not appear. ![]() All sections, subsections, subsubsections, etc. You can add a table of contents using the Doxygen command \tableofcontents. ![]() Sphinx chooses one of two setups for the maths.While the file_name portion is not necessary, it is useful for reducing the likelihood of reference collisions. But I suspect that the original submitter meant the same problem as my current issue is for. In the end, the applied fix was to add a negative space to nudge aligned output slightly to the left. The original issue Toggle old alignment behavior for equations #2370 mentioned right-alignment vs. With Toggle old alignment behavior for equations #236accb, we changed it to split in equation* (for single equations) or aligned inside align* (for multiple equations). This is useful for if you want to align equations using &. With Use "align" environment to wrap math equations instead of "gather" #2254, we changed it to be split inside align*. In the past, equations used to be always right-aligned, with split inside gather. I would like the maths to be centered, and I think right-aligning is a bad default to choose in this case.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |