Add document structure marker for types
Let's swipe something from DocC, for a change, instead of rustdoc.
Adding a Topics
section to an index-level docblock will replace the standard index with a manually defined structure, e.g.
/**
* SomeObject:
*
* Does something.
*
* The regular description of `SomeObject`, which gets used for the class
* description.
*
* ## A sub-section
*
* ...
*
* ## CSS selectors
*
* ...
*
* ## SomeObject as a GtkBuildable
*
* ...
*
* ## Topics
*
* ### Essentials
*
* [Layout and geometry](layout.html):
* Constructing layouts and determining size and position with SomeObject.
*
* [Event handling](events.html)
* Responding to user interactions.
*
* [Rendering](rendering.html)
* Drawing the contents of SomeObject.
*
* ### Creating new SomeObject instances
*
* - [ctor@SomeObject.new]: basic constructor
* - [ctor@SomeObject.new_for_foo]: constructing a SomeObject representing a Foo
* - [ctor@SomeObject.new_for_bar]: constructing a SomeObject representing a Bar
*
* ### Layouts
*
* - [method@SomeObject.set_position]: setting the position of SomeObject
* - [method@SomeObject.set_size]: setting the size of SomeObject
* - [property@SomeObject:z-position]: accessing the Z coordinate of SomeObject
* - [signal@SomeObject::position-changed]: notification changes of SomeObject position
* - [vfunc@SomeObject.queue_resize]: intercept a resize request
*/
will render the class index of SomeObject
without the typical
- Constructors
- Static functions
- Methods
- Properties
- Signals
- Virtual functions
structure; instead, the sections will be extracted from the Topics
section.