![]() ![]() linuxuser27 wow, that's not happening with my settings, i.e. If you create a single line with 3 '///' when you hit enter for a new line, the new line will also begin with 3 '///' slashes. Sphinx cross references can refer to symbols that have not yet beenĭocumented. Arkady I don't really understand what 'boring' means in this case. ![]() Or include () in macros that shouldn’t have them. References sometimes render as plain text instead of code-style monospace, Sphinx cross references always use consistent formatting. cpp:class:: or extracted from Python.ĭoxygen references can only refer to identifiers known to Doxygen. Sphinx cross references work for all identifiers known to Sphinx, including Provides other methods for cross references, but Sphinx cross references Use the aliases described above for all cross references. ForĮxample, the following comment documents two macros: To group multiple symbols into a single commentīlock, include a structural commands for each symbol on its own line. One case where structural commands are necessary is when a single comment blockĭescribes multiple symbols. Necessary, since they are redundant with the declarations themselves. ![]() Example of these include and Do not use these unless This is rendered as a definition Add a noteĪdmonition to the end of To bold one word.ĭoxygen provides structural commands that associate aĬomment block with a particular symbol. Paragraph where the postcondition of an entity can be Single Paragraph where the precondition of an entity can be Starts a Pigweed prefers to use RST wherever possible, but there are a few DoxygenĬommon Doxygen commands for use within a comment To start a reStructuredText block. / #define PW_LOCK_RETURNED(x) _attribute_((lock_returned(x))) Doxygen syntax # I think the safest thing to say about having multiple \mainpage commands is that it is undefined in the classic sense of yielding unpredictable results depending on version and platform. To override the language /// use /// /// /// class Foo /// /// /// The first word in this sentence is bold (The). The \mainpage command specifies content used to customise the index page, so if you lack one it's just a blank page with the normal Doxygen header and footer. code-block:: cpp /// /// void release(ptrdiff_t update = 1) /// /// /// Example code block using Doxygen markup below. warning:: /// this is a warning admonition /// ///. / /// /// The and commands form a block block of /// reStructuredText that is rendered in Sphinx. / DATA_LOSS KVS initialized and is usable, but contains corrupt data. / n The number of bytes to copy /// /// OK KVS successfully initialized. Then I can see the docs by highlighting the foo() call and hitting f1, but I cant easily preview them while. For example, which is /// shorthand for links to a C++ /// class. / /// Doxygen comments can refer to other symbols using Sphinx cross /// references. / This is the documentation comment for the `PW_LOCK_RETURNED()` macro. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |