Skip to main content

Module doc_comment

Module doc_comment 

Source

Structs§

DocComment
Structured documentation parsed from a Doxygen-style comment.

Functions§

build_doc_map
Build a map from declaration (start_byte, end_byte) to parsed documentation.
parse_comment_content
Parse a single raw comment string (e.g. /// line or /** ... */) into a DocComment. Used by .sig loader for Doxygen-style blocks. is_block is true for /***/.
parse_doc_comment
Parse one or more raw comment strings (e.g. from multiple preceding trivia tokens). If the combined text contains a block comment (/** ... */), only that block is used so that a preceding line comment (e.g. // Comment) does not corrupt the doc block.