Timetool for primos3/10/2023 To support documentation extraction from C, C++ code and also standalone descriptive text files that include PlantUML diagrams.For the documention to be pretty and modern looking.To create documentation for users of the software - developers, and end-users.Documentation written in a Wiki or Markup language.the documentation should not duplicate the code instead complement it. The Journey to Documentation as Code began over a decago ago when either no documentation, or MS Word Documents were common. In more orgainised companies, these documents were maintained in MS Sharepoint. Many years back, we made the transition from MS Word documents to Wikis - Living Documents. ![]() I was a strong proponent getting people from documents in sharepoint. Today we use Confluence which makes it easy for everyone to add content or provide comments on it. However, the content becomes stale and is disconnected from the code and software teams. Many community projects use Confluence for user documentation e.g. Apache which is a wiki containing user-contributed recipes, tips, and tricks for the Apache HTTP Server. Github supports several markup languages for documentation the most popular ones are Markdown and reStructuredText. Static Site Generators with content in GitHub e.g. ![]() Doxygen is heavily used for documenting C++ software.īitbucket supports Markdown, reStructured Text, Textile and Creole Toolset The Linux kernel uses () to generate pretty documentation from () files under DocumentationĬ, C++ĝoxygen is a widely used system that generates documentation from annotated source code. We will use Exhale which is an automatic C++ library API generation utility. It imports Doxygen output into the Sphinx domain (via a Breathe bridge).
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |