code: cleanup some docunits

Signed-off-by: Jean Privat <jean@pryen.org>

diff --git a/lib/standard/collection/sorter.nit b/lib/standard/collection/sorter.nit
index ca16460..9157995 100644 (file)
--- a/lib/standard/collection/sorter.nit
+++ b/lib/standard/collection/sorter.nit
@@ -25,10 +25,12 @@ interface Comparator
        type COMPARED: nullable Object
 
        # Compare `a` and `b`.
+       #
        # Returns:
-       #       -1 if a < b
-       #       0  if a = b
-       #       1  if a > b
+       #
+       # * -1 if a < b
+       # * 0  if a = b
+       # * 1  if a > b
        fun compare(a: COMPARED, b: COMPARED): Int is abstract
 
        # Is `seq` sorted?

diff --git a/lib/standard/file.nit b/lib/standard/file.nit
index 80b3cd9..0ff5577 100644 (file)
--- a/lib/standard/file.nit
+++ b/lib/standard/file.nit
@@ -77,9 +77,10 @@ abstract class FileStream
        # If the buf_size is <= 0, its value will be 512 by default
        #
        # The mode is any of the buffer_mode enumeration in `Sys`:
-       #       - buffer_mode_full
-       #       - buffer_mode_line
-       #       - buffer_mode_none
+       #
+       # * `buffer_mode_full`
+       # * `buffer_mode_line`
+       # * `buffer_mode_none`
        fun set_buffering_mode(buf_size, mode: Int) do
                if buf_size <= 0 then buf_size = 512
                if _file.set_buffering_type(buf_size, mode) != 0 then

diff --git a/lib/standard/ropes.nit b/lib/standard/ropes.nit
index 902649a..b6f16f5 100644 (file)
--- a/lib/standard/ropes.nit
+++ b/lib/standard/ropes.nit
@@ -36,11 +36,13 @@
 #
 # Example :
 #
+# ~~~raw
 #                  Concat
 #                /        \
 #          Concat          Concat
 #         /      \        /      \
 #      "My"     " Name"  " is"   " Simon."
+# ~~~
 #
 # Note that the above example is not representative of the actual implementation
 # of `Ropes`, since short leaves are merged to keep the rope at an acceptable

diff --git a/src/compiler/coloring.nit b/src/compiler/coloring.nit
index e2afc48..bff3243 100644 (file)
--- a/src/compiler/coloring.nit
+++ b/src/compiler/coloring.nit
@@ -439,16 +439,21 @@ end
 # No coloring order is garantied
 #
 # Example:
-#      buckets[A] = {x1, x2}
-#   buckets[B] = {x1, x3, x4}
-#      buckets[C] = {x2, x3}
+#
+# * buckets[A] = {x1, x2}
+# * buckets[B] = {x1, x3, x4}
+# * buckets[C] = {x2, x3}
+#
 # Conflicts:
-#      x1: {x2, x3, x4}
-#   x2: {x1, x3}
-#   x3: {x1, x2, x4}
-#   x4: {x1, x3}
+#
+# * x1: {x2, x3, x4}
+# * x2: {x1, x3}
+# * x3: {x1, x2, x4}
+# * x4: {x1, x3}
+#
 # Possible colors:
-#      x1: 0, x2: 1, x3: 2, x4: 1
+#
+# * x1: 0, x2: 1, x3: 2, x4: 1
 class BucketsColorer[H: Object, E: Object]
        private var colors = new HashMap[E, Int]
        private var conflicts = new HashMap[E, Set[E]]

diff --git a/src/toolcontext.nit b/src/toolcontext.nit
index 8196aeb..4468d91 100644 (file)
--- a/src/toolcontext.nit
+++ b/src/toolcontext.nit
@@ -574,16 +574,18 @@ end
 #
 # On some Linux systems `bash_completion` allow the program to control command line behaviour.
 #
-#      $ nitls [TAB][TAB]
-#      file1.nit              file2.nit              file3.nit
+# ~~~sh
+# $ nitls [TAB][TAB]
+# file1.nit              file2.nit              file3.nit
 #
-#      $ nitls --[TAB][TAB]
-#      --bash-toolname        --keep                 --path                 --tree
-#      --depends              --log                  --project              --verbose
-#      --disable-phase        --log-dir              --quiet                --version
-#      --gen-bash-completion  --no-color             --recursive            --warn
-#      --help                 --only-metamodel       --source
-#      --ignore-visibility    --only-parse           --stop-on-first-error
+# $ nitls --[TAB][TAB]
+# --bash-toolname        --keep                 --path                 --tree
+# --depends              --log                  --project              --verbose
+# --disable-phase        --log-dir              --quiet                --version
+# --gen-bash-completion  --no-color             --recursive            --warn
+# --help                 --only-metamodel       --source
+# --ignore-visibility    --only-parse           --stop-on-first-error
+# ~~~
 #
 # Generated file can be placed in system bash_completion directory `/etc/bash_completion.d/`
 # or source it in `~/.bash_completion`.