doc: move comment spec
@@ -81,6 +81,48 @@ note= if used within specifications it refers to the specification, not
the key. Use `description` to refer to the key.
+[comment/#]
+status=implemented
+usedby/plugin= hosts
+type = string
+description= comment line preceding an actual key
+ Except #0, which is the inline key (in the same line).
+ The comment numbering starts from top to bottom. The comment
+ directly above the key is the last entry in the array and
+ the topmost comment belonging to the key is #1.
+ Comment keys that are not above any key (comments in the last
+ lines of files) are added to the parentkey.
+
+ It allows:
+ - to restore formatting, including:
+ - inline comments
+ - spaces before comments
+ - empty lines
+ - to distinguish between different kinds of comments and empty lines
+ - to tag every single comment line, which increases extensibility
+
+ It needs, however, an API so that the user is not required to fiddle
+ with all these details. (to be done)
+note= Other libraries doing similar things:
+ http://commons.apache.org/proper/commons-configuration/apidocs/org/apache/commons/configuration2/PropertiesConfigurationLayout.html
+ http://code.google.com/p/bracket-properties/
+
+[comment/#/start]
+status= implemented
+usedby/plugin= hosts
+type= string
+description= determines the character used to start this line of comment
+ None if its an empty line
+
+[comment/#/space]
+status= implemented
+usedby/plugin= hosts
+type= string
+description= the space used between a comment and the beginning of the
+ line or after end of payload data (for inline comments)
+ If no start token was found, only space and no comment is present.
+
+
[line]
@@ -748,49 +790,6 @@ description= to not avoid metakeys with standard system keys, no metakey name mu
-
-[comment/#]
-status=implemented
-usedby/plugin= hosts
-type = string
-description= comment line preceding an actual key
- Except #0, which is the inline key (in the same line).
- The comment numbering starts from top to bottom. The comment
- directly above the key is the last entry in the array and
- the topmost comment belonging to the key is #1.
- Comment keys that are not above any key (comments in the last
- lines of files) are added to the parentkey.
-
- It allows:
- - to restore formatting, including:
- - inline comments
- - spaces before comments
- - empty lines
- - to distinguish between different kinds of comments and empty lines
- - to tag every single comment line, which increases extensibility
-
- It needs, however, an API so that the user is not required to fiddle
- with all these details. (to be done)
-note= Other libraries doing similar things:
- http://commons.apache.org/proper/commons-configuration/apidocs/org/apache/commons/configuration2/PropertiesConfigurationLayout.html
- http://code.google.com/p/bracket-properties/
-
-[comment/#/start]
-status= implemented
-usedby/plugin= hosts
-type= string
-description= determines the character used to start this line of comment
- None if its an empty line
-
-[comment/#/space]
-status= implemented
-usedby/plugin= hosts
-type= string
-description= the space used between a comment and the beginning of the
- line or after end of payload data (for inline comments)
- If no start token was found, only space and no comment is present.
-
-
#
# Plugin specific Metadata
#
