Generate an outline in the specification

[gallandarakhneorg]

Consider a long specification with plenty of elements inside:

/* Documentation
 */
describe "something" {
    describe "element_1" {
        ...
    }
    ...
    describe "element_25" {
        ...
    }
}

I suggest to introduce a tag in the documentation that permits to create a kind of outline which is the list of the elements in the spec.

For example, I will be able to write my documentation as:

/* Introductive text.
 *
 * @outline(1)
 *
 * Rest of the documentation.
 */
describe "something" {
   ...
}

The tag "@outline" is generating an HTML list that contains links to the elements of depth 1 (the parameter's value) such as:

• element_1
• ...
• element_25