diff --git a/docs/Development/Policies-and-Procedures/.pages b/docs/Development/Policies-and-Procedures/.pages index c9b79697af..78592fdaf2 100644 --- a/docs/Development/Policies-and-Procedures/.pages +++ b/docs/Development/Policies-and-Procedures/.pages @@ -4,6 +4,7 @@ nav: - AI-Policy.md - Commit-Messages.md - Coding-Guidelines.md + - XML-Documentation.md - Software-Configuration-Management-Policies.md - Bug-Fixes.md - C-API-Deprecation.md diff --git a/docs/Development/Policies-and-Procedures/XML-Documentation.md b/docs/Development/Policies-and-Procedures/XML-Documentation.md new file mode 100644 index 0000000000..f9040c30d8 --- /dev/null +++ b/docs/Development/Policies-and-Procedures/XML-Documentation.md @@ -0,0 +1,16 @@ +# XML Documentation + +Since XML documentation is done in the source tree, some of the files can become quite large. Because of this, the XML should be separated from the C files to remove clutter. When submitting a PR that requires documentation, it should be added to its corresponding XML file (or create a new one if one does not already exist). For example, chan_websocket has its own XML file (channels/chan_websocket_doc.xml). These existing files can be referred to when creating your own. + +Here are the requirements for the doc file: +* The filename has to have the "\_doc.xml" suffix +* The file must begin with: +```xml + + + +``` +* To enclose the above, the file must end with: +```xml + +```