ppForge
/
NetworkProtocolDictionary
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added documentation schema for fields

This commit is contained in:
Marcel 2015-01-04 17:14:17 +01:00
parent e0f4ed4034
commit 3d13e11e13
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
structure-schema.yml
View File

@ -79,4 +79,19 @@ mapping:
"fields": "fields":
type: seq type: seq
sequence: *fieldsseq sequence: *fieldsseq
#"documentation": #todo! "documentation":
type: map
mapping:
"summary": # a summary about this protocol (optional)
type: str
"descriptions": # descriptions of the fields
type: seq
sequence:
- type: map
mapping:
"field": # field name as defined in the protocol structure
type: str
required: yes
"desc": # description
type: str
required: yes