Search code examples
rustrustdoc

Is it possible to group sections of an API with rustdoc?


Is it possible to group sections of an API? related functions, types or constants for example.

Doxygen for example supports grouping like this:

/** \name Some API Grouping
 * \{ */

// code //

/* \} */

Is rustdoc capable of something similar?


Solution

  • No.

    Would be nice, but sadly no.

    Edit: As noted by Matthieu M., you can add doc comments to individual impl blocks, but that doesn't solve the general case.