Merge: Improve documentation of kernel
authorJean Privat <jean@pryen.org>
Sat, 25 Jul 2015 01:17:47 +0000 (21:17 -0400)
committerJean Privat <jean@pryen.org>
Sat, 25 Jul 2015 01:17:47 +0000 (21:17 -0400)
commit34a7990c32b5100a418f9185ecf153c1c422f896
tree0a9b0675298a33d1685d9bb78024c6c0611edc16
parentc322d371a74a473934db7dd934746443caa3b215
parenta36acc5ce4a3adb6e381dcdf8261e90f6b9e4e05
Merge: Improve documentation of kernel

Improve the documentation of Object and Sys.
Also experiments with the new nitdoc features #1447

Some issues I discovered while writing and using the doc while thinking about nitdoc.

* micro-picking classes and methods to include in the README is not fun
* headings (`###`) in the markdown might not have the right level in the generated HTML
* having reified property groups (#1413) should help to organize thing and have automatic feedback on it trough the doc
* maybe the `[[list:]]` directive should no list entities not already included by `[[doc:]]` (or a new `[[list_other:]]` directive?)
* having a way to generate a full linear and strucuted documentation in a single page could simplify the job of the writer when checking the doc.

Pull-Request: #1584
Reviewed-by: Alexandre Terrasa <alexandre@moz-code.org>
Reviewed-by: Lucas Bajolet <r4pass@hotmail.com>
lib/standard/kernel.nit
tests/sav/error_class_glob.res