Documentation
¶
Overview ¶
Tickdoc is a simple utility similar to godoc that generates documentation from comments.
The 'tickdoc' utility understands several special comments to help it generate clean documentation.
1. tick:ignore -- can be added to any field, method, function or struct and tickdoc will simply skip it and not generate any documentation for it. Useful for ignore fields that are set via property methods.
2. tick:property -- is only added to methods and informs tickdoc that the method is a property method not a chaining method.
3. tick:embedded:[NODE_NAME].[PROPERTY_NAME] -- The object's properties are embedded into a parent node's property identified by NODE_NAME.PROPERTY_NAME.
4. tick:wraps:[INTERNAL_FIELD] - use the comments associate with the internal field to describe the wrapper type
Just place one of these comments on a line all by itself and tickdoc will find it and behave accordingly.
Example:
// Normal comments
//
// Other comments
// tick:ignore
type A struct{}
Tickdoc will format examples like godoc but assumes the examples are TICKscript instead of golang code and styles them accordingly.
Otherwise just document your code normally and tickdoc will do the rest.
Source Files