Odwiedź stronę Dokumentacja źródeł, aby uzyskać instrukcje dotyczące tworzenia dokumentacji FreeCAD, która jest również dostępna online na witrynie FreeCAD API. Niniejszy dokument zawiera krótkie wprowadzenie do Doxygen, w szczególności w jaki sposób jest on używany w FreeCAD do dokumentowania jego źródeł. Odwiedź stronę Doxygen, aby dowiedzieć się więcej o systemie, i zapoznaj się z Podręcznikiem Doxygen, aby uzyskać pełne informacje. Or look at some examples? -> linking to doxygen.Doxygen jest popularnym narzędziem do generowania dokumentacji z adnotacji w źródłach C++ obsługuje również inne popularne języki programowania, takie jak C#, PHP, Java i Python. Maybe you want to know more about the inner workings? -> head over to the reference section. To get to know the doxysphinx comment syntax -> see our syntax guide. To link from sphinx documentation directly to doxygen documented symbols -> see our setting up doxylink guide.( Strongly recommended.) ![]() Further Recommendation # Recommended Setup # ![]() □ Congratulations you’ve completed the quickstart. Now run doxygen, doxysphinx and sphinx and look at the generated documentation. See also the Syntax Guide for a complete documentation on how to comment for doxysphinx. Inside these tags you can write any rst code. / /// Car ( Engine & engine, Color & color ) hint:: /// Rst text can also be included after the params. / /// engine - the engine to use for this Car. The default value is the current working directory. If nothing is entered, the default value is “doxygen”. which are dynamically generating doxygen configs. This is more like an “expert”-mode which is especially useful when integrating doxysphinx with buildsystems like cmake etc.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |