9 Documentation Storage
9.1 EEP-48: Documentation storage and format
EEP-48 defines a common documentation storage format for module documentation in the Erlang/OTP ecosystem. Erl_Docgen can generate documentation in this format from XML files following the DTD's descibed in the other User's Guides in this application.
Some special considerations have to be taken when writing documentation that should also be available through EEP-48 style storage.
- The #PCDATA within <name> tags must be parseable to figure out the arity of the function.
- It is not allowed to mix <name> tags with #PCDATA and attributes.
- All <name> tags within <func> has to have a since attribute.
- All callback function documentations have to start with a Module prefix.
9.2 Erlang Documentation Format
When generating documentation for generic storage