Skip to main content

Module doc_emission

Module doc_emission 

Source
Expand description

Language-native documentation comment emission. Provides standardized functions for emitting doc comments in different languages.

Functions§

emit_csharp_doc
Emit C# XML documentation comments (/// ) Used for C# classes, structs, methods, and properties.
emit_dartdoc
Emit Dartdoc-style documentation comments (///) Used for Dart classes, methods, and properties.
emit_elixir_doc
Emit Elixir documentation comments (@doc) Used for Elixir modules and functions.
emit_gleam_doc
Emit Gleam documentation comments (///) Used for Gleam functions and types.
emit_javadoc
Emit Javadoc-style documentation comments (/** … */) Used for Java classes, methods, and fields. Handles XML escaping and Javadoc tag formatting.
emit_kdoc
Emit KDoc-style documentation comments (/** … */) Used for Kotlin classes, methods, and properties.
emit_phpdoc
Emit PHPDoc-style comments (/** … */) Used for PHP classes, methods, and properties.
emit_roxygen
Emit R roxygen2-style documentation comments (#’) Used for R functions.
emit_rustdoc
Emit Rust /// documentation comments.
emit_swift_doc
Emit Swift-style documentation comments (///) Used for Swift structs, enums, and functions.
emit_zig_doc
Emit Zig documentation comments (///) Used for Zig functions, types, and declarations.