Skip to content

Commit 20e4a33

Browse files
bkfordgtjoseph
authored andcommitted
Added XML Documentation policy page.
1 parent 6082fcd commit 20e4a33

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/Development/Policies-and-Procedures/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ nav:
44
- AI-Policy.md
55
- Commit-Messages.md
66
- Coding-Guidelines.md
7+
- XML-Documentation.md
78
- Software-Configuration-Management-Policies.md
89
- Bug-Fixes.md
910
- C-API-Deprecation.md
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# XML Documentation
2+
3+
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.
4+
5+
Here are the requirements for the doc file:
6+
* The filename has to have the "\_doc.xml" suffix
7+
* The file must begin with:
8+
```xml
9+
<?xml version="1.0" encoding="UTF-8"?>
10+
<!DOCTYPE docs SYSTEM "appdocsxml.dtd">
11+
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
12+
```
13+
* To enclose the above, the file must end with:
14+
```xml
15+
</docs>
16+
```

0 commit comments

Comments
 (0)