readme: add information section

[nit.git] / src / doc / doc_commands.nit

diff --git a/src/doc/doc_commands.nit b/src/doc/doc_commands.nit
index 7241742..e69bb38 100644 (file)
--- a/src/doc/doc_commands.nit
+++ b/src/doc/doc_commands.nit
@@ -45,6 +45,8 @@ interface DocCommand
                        return new ArticleCommand(command_string)
                else if command_string.has_prefix("comment:") then
                        return new CommentCommand(command_string)
+               else if command_string.has_prefix("list:") then
+                       return new ListCommand(command_string)
                else if command_string.has_prefix("param:") then
                        return new ParamCommand(command_string)
                else if command_string.has_prefix("return:") then
@@ -107,6 +109,13 @@ class CommentCommand
        super AbstractDocCommand
 end
 
+# A `DocCommand` that includes a list of something.
+#
+# Syntax: `list:kind: <arg>`.
+class ListCommand
+       super AbstractDocCommand
+end
+
 # A `DocCommand` that includes the list of methods tanking a `MType` as parameter.
 #
 # Syntax: `param: MType`.