doc/oran-interface.rst

   1 Example Module Documentation
   2 ----------------------------
   3
   4 .. include:: replace.txt
   5 .. highlight:: cpp
   6
   7 .. heading hierarchy:
   8    ------------- Chapter
   9    ************* Section (#.#)
  10    ============= Subsection (#.#.#)
  11    ############# Paragraph (no number)
  12
  13 This is a suggested outline for adding new module documentation to |ns3|.
  14 See ``src/click/doc/click.rst`` for an example.
  15
  16 The introductory paragraph is for describing what this code is trying to
  17 model.
  18
  19 For consistency (italicized formatting), please use |ns3| to refer to
  20 ns-3 in the documentation (and likewise, |ns2| for ns-2).  These macros
  21 are defined in the file ``replace.txt``.
  22
  23 Model Description
  24 *****************
  25
  26 The source code for the new module lives in the directory ``contrib/oran-interface``.
  27
  28 Add here a basic description of what is being modeled.
  29
  30 Design
  31 ======
  32
  33 Briefly describe the software design of the model and how it fits into
  34 the existing ns-3 architecture.
  35
  36 Scope and Limitations
  37 =====================
  38
  39 What can the model do?  What can it not do?  Please use this section to
  40 describe the scope and limitations of the model.
  41
  42 References
  43 ==========
  44
  45 Add academic citations here, such as if you published a paper on this
  46 model, or if readers should read a particular specification or other work.
  47
  48 Usage
  49 *****
  50
  51 This section is principally concerned with the usage of your model, using
  52 the public API.  Focus first on most common usage patterns, then go
  53 into more advanced topics.
  54
  55 Building New Module
  56 ===================
  57
  58 Include this subsection only if there are special build instructions or
  59 platform limitations.
  60
  61 Helpers
  62 =======
  63
  64 What helper API will users typically use?  Describe it here.
  65
  66 Attributes
  67 ==========
  68
  69 What classes hold attributes, and what are the key ones worth mentioning?
  70
  71 Output
  72 ======
  73
  74 What kind of data does the model generate?  What are the key trace
  75 sources?   What kind of logging output can be enabled?
  76
  77 Advanced Usage
  78 ==============
  79
  80 Go into further details (such as using the API outside of the helpers)
  81 in additional sections, as needed.
  82
  83 Examples
  84 ========
  85
  86 What examples using this new code are available?  Describe them here.
  87
  88 Troubleshooting
  89 ===============
  90
  91 Add any tips for avoiding pitfalls, etc.
  92
  93 Validation
  94 **********
  95
  96 Describe how the model has been tested/validated.  What tests run in the
  97 test suite?  How much API and code is covered by the tests?  Again,
  98 references to outside published work may help here.