This is a suggested outline for adding new module documentation to ns-3.
See src/click/doc/click.rst for an example.
The introductory paragraph is for describing what this code is trying to model.
The source code for the new module lives in the directory src/plc.
Add here a basic description of what is being modeled.
Briefly describe the software design of the model and how it fits into the existing ns-3 architecture.
What can the model do? What can it not do? Please use this section to describe the scope and limitations of the model.
Add academic citations here, such as if you published a paper on this model, or if readers should read a particular specification or other work.
This section is principally concerned with the usage of your model, using the public API. Focus first on most common usage patterns, then go into more advanced topics.
Include this subsection only if there are special build instructions or platform limitations.
What helper API will users typically use? Describe it here.
What classes hold attributes, and what are the key ones worth mentioning?
What kind of data does the model generate? What are the key trace sources? What kind of logging output can be enabled?
Go into further details (such as using the API outside of the helpers) in additional sections, as needed.
What examples using this new code are available? Describe them here.
Add any tips for avoiding pitfalls, etc.
Describe how the model has been tested/validated. What tests run in the test suite? How much API and code is covered by the tests? Again, references to outside published work may help here.