Documentation plays a vital role in all the development process in multiple ways. Some of them includes description of the declaration, definition and implementations, indication of author when the source is common base across multiple developers, mark up of timeline when it is being developed during a time period and so on.
Apart from all of the above, documentation helps the users of the source to understand it clearly based on the comments provided. It also gives options for finding relation between classes, callers and calls to and of the function.
DOxygen is one of the good tool that I came across which gives a documentation with detailed parsing of the source with various diagrams that would help a most for a starter.
DOxygen is a standalone tool that is used for the creation of document for any source code. It supports a wide range of programming language such as C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran, and D. It uses a tool named "DOT" for creating pictures of classes, graphs of calls and callers. This tool has been provided by Graphviz.
Usage of DOxygen is not much complicated, but it requires a continuous part in the development of source code, where the developer has to put appropriate comments.
DOxygen provides standard formats for providing comments in the source base. It also provides various functions which can be used effectively during the document creation.
A list of various functions that DOxygen provides can be found in the following page.
DOxygen Functions
Configuration and usage of has been explained more neatly in the following link.
DOxygen Manual
Apart from all of the above, documentation helps the users of the source to understand it clearly based on the comments provided. It also gives options for finding relation between classes, callers and calls to and of the function.
DOxygen is one of the good tool that I came across which gives a documentation with detailed parsing of the source with various diagrams that would help a most for a starter.
DOxygen is a standalone tool that is used for the creation of document for any source code. It supports a wide range of programming language such as C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran, and D. It uses a tool named "DOT" for creating pictures of classes, graphs of calls and callers. This tool has been provided by Graphviz.
Usage of DOxygen is not much complicated, but it requires a continuous part in the development of source code, where the developer has to put appropriate comments.
DOxygen provides standard formats for providing comments in the source base. It also provides various functions which can be used effectively during the document creation.
A list of various functions that DOxygen provides can be found in the following page.
DOxygen Functions
Configuration and usage of has been explained more neatly in the following link.
DOxygen Manual
