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?
Asked
Active
Viewed 434 times
5
albert
- 8,285
- 3
- 19
- 32
ideasman42
- 42,413
- 44
- 197
- 320
1 Answers
4
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.
DK.
- 55,277
- 5
- 189
- 162
-
What of the fact that the methods are grouped per `impl`? It's implicit but is already some form of grouping. – Matthieu M. Nov 01 '16 at 09:08
-
@MatthieuM. That *does* work for methods (since you can attach docs to `impl`s), but it doesn't help for free functions, types, or constants. – DK. Nov 01 '16 at 09:20
-
Yes, better than nothing :) – Matthieu M. Nov 01 '16 at 09:31