Documentation
¶
Overview ¶
Package docparser provides a unified documentation comment parsing infrastructure with sub-packages for each documentation format across multiple programming languages.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocComment ¶
type DocComment struct {
Summary string
Description string
Params []ParamDoc
Returns *ReturnDoc
Deprecated string
Since string
See []string
Examples []string
Throws []ThrowDoc
}
DocComment holds structured documentation extracted from any doc comment format. All language-specific parsers produce this common type.
type Parser ¶
type Parser interface {
Parse(raw string) *DocComment
}
Parser is the interface that all documentation format parsers implement.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package doxygen parses C/C++ Doxygen documentation comments into structured DocComment values.
|
Package doxygen parses C/C++ Doxygen documentation comments into structured DocComment values. |
|
Package godoc parses Go doc comments into structured DocComment values.
|
Package godoc parses Go doc comments into structured DocComment values. |
|
Package javadoc parses JavaDoc comment blocks (/** ...
|
Package javadoc parses JavaDoc comment blocks (/** ... |
|
Package jsdoc parses JSDoc comment blocks (/** ...
|
Package jsdoc parses JSDoc comment blocks (/** ... |
|
Package phpdoc parses PHPDoc comment blocks (/** ...
|
Package phpdoc parses PHPDoc comment blocks (/** ... |
|
Package pydoc parses Python docstrings into structured DocComment values.
|
Package pydoc parses Python docstrings into structured DocComment values. |
|
Package rustdoc parses Rust documentation comments (/// and //!) into structured DocComment values.
|
Package rustdoc parses Rust documentation comments (/// and //!) into structured DocComment values. |
|
Package xmldoc parses C# XML documentation comments (/// lines or /** ...
|
Package xmldoc parses C# XML documentation comments (/// lines or /** ... |
|
Package yard parses Ruby YARD documentation comments into structured DocComment values.
|
Package yard parses Ruby YARD documentation comments into structured DocComment values. |
Click to show internal directories.
Click to hide internal directories.