We maintain documentation in the following forms:
The following auxiliary files are managed by the core INET maintainers:
ChangeLogfile in a fixed format. ChangeLogs exist so that users can get a high level overview of the history of that component. It is usually derived from the git log by heavy editing for conciseness and clarity, e.g. by combining a series of related commit messages into a single change summary. (The git log is often too detailed and contains too much “noise” for end-user consumption.)
Content and level of details:
However, it should not:
We use Doxygen and the OMNeT++ IDE (Project -> Generate NED Documentation) to generate hyperlinked documentation from source code. The following rules help us achieve that the generated documentation is useful and looks good.
the ~TCP module(hyperlinks the TCP module), but:
the TCP protocol(no hyperlink).
@brieflines are usually not needed.
/** */comments for private data members, private methods, etc. (We recommend