![]() ![]() The reader is referred to the Markdown site for more details. In the next section the standard Markdown features are briefly discussed. While Markdown's syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown's syntax is the format of plain text email. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. The design goal for Markdown's formatting syntax is to make it as readable as possible. It is a plain text formatting syntax written by John Gruber, with the following underlying design goal: The path need's to be hardcoded.Īs stated above, Doxygen is the de facto standard tool for generating documentation.Ĭheers, Gal.Markdown support was introduced in doxygen version 1.8.0. Doxgen conf-file can't process shell environment variables such as $HOME, or ~. You don't need to keep all generated files, the conf-file is enough. + Doxygen configuration file is portable. With zero efforts, mathematics can become a part of the documentation! * - wait until mode is tello_protocol::FlyModes::LANDING \n * Rolling amount measured in \f$ \text\% \f$ <- MATHJAX * - SetRoll in a range from \f$0 \rightarrow 0.5 \rightarrow 0 \rightarrow -0.5\f$ \n <- MATHJAX * - wait until mode is tello_protocol::FlyModes::HOLDING_POSITION \n I didn't need to use complex math in this project, hence I've made a simple MATH use: /** In their site, they provide a description that is friendly enough. How to use MATHJAX in Doxygen documentation Thus after generating documentation it processed without a fuss: If the project is documented according to Doxygen's syntax from start (I did change the interface name, so eventually, the design wasn't strictly followed. Using Doxygen auto-generated graphs - I could rest assure that the mechanism of the observer-observable pattern was implemented accordingly (see the similarity): Take a closer look at the ISubject and its users. Here are the class relations designs that I made for the TelloCpp driver project. Using this tool, you can assure that his project follows preliminary designs. You can access the generated documentation via the index.html file: ![]() # Enable this If you have mathjax inside your documentationĬd /home/gal/dev/tello_driver/docs # Doxygen file directoryĪ successful doxy-generation looks like that: # Include functions body to the generated HTML's LINE 1029 - USE_MDFILE_AS_MAINPAGE = /home/gal/dev/tello_driver/README.md # This makes a main-page out of a markdown. LINE 953 - EXAMPLE_PATH = /home/gal/dev/tello_driver/examples Organize all the /** */ annotations under Examples page. ( Note: See how I entered a list of paths here) LINE 920 - EXCLUDE = /home/gal/dev/tello_driver/build /home/gal/dev/tello_driver/lib/googletest /home/gal/dev/tello_driver/lib/spdlog If one's project has libraries that also include documentation, they could exclude them from being doxy-generated along with the project. This is the main entrance of the project path: LINE 832 - INPUT = "/home/gal/dev/tello_driver/" These next settings are nice, they make all the /** */ documentation appear under a page called TODO LINE 664 - GENERATE_TODOLIST = YES One might turn off some of these settings. Mind that if a project is to be exported as a package, These are scope-related documentation settings: LINE 61 - OUTPUT_DIRECTORY = "/home/gal/dev/tello_driver/docs/doxygen" LINE 54 - PROJECT_LOGO = "/home/gal/dev/tello_driver/docs/TelloCppDriver.jpg" LINE 47 - PROJECT_BRIEF = "A one of its kind TelloCpp driver, that supports the unofficial SDK." Some general settings: LINE 35 - PROJECT_NAME = "TelloCpp driver" But don't worry, tweaking with it is easy, here is what I changed in it: This is a huge file (with 2580 lines in it!). ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |