![]() ![]() 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!). Editing the generated configuration file:.Simply put - it generates an HTML out of a documented project. I took the opportunity to learn how to Doxygen:ĭoxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL and to some extent D. If a function/class cannot be described in 1 sentence, then it is not designed properly.It makes it easy to resume developing a neglected code.In my previous post, I've described how I used design patterns for my TelloCpp driver.īut, while project design is important - A project is nothing without proper documentation Menu Learn how to use doxygen 14 March 2021 on cpp, C++, code, Tello, TelloPy, tello-driver, tello_driver, Doxygen, documentation ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |