Sha256: f35a54ee0baebac47ae9437fd5fe2628adcd7df183bd98660c9a687cb88293ad

Contents?: true

Size: 761 Bytes

Versions: 11

Compression:

Stored size: 761 Bytes

Contents

# documentation_formatters.fy
# Example of fancy's documentation formatters

foo = Object new

Fancy Documentation for: foo is: """
## Fancy documentation.

 It should be possible to set documentation for any _arbitray object_.
 Doing so will expose it on the API documents.
 This can be useful for constants, or singleton objects.

## Fancy Documentation formatters

 Fancy you to create custom documentation formatters,
 thus, allowing you to display an object document in a well
 formatted way for different environments, eg. when using the
 interactive REPL you may want *ANSI* _colored_ output, or maybe
 we create a tool to generate MAN(1) pages, and fdoc tool
 to generate HTML API docs.

"""

Fancy Documentation for: foo . format: 'markdown . println

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
fancy-0.10.0 examples/documentation_formatters.fy
fancy-0.9.0 examples/documentation_formatters.fy
fancy-0.8.0 examples/documentation_formatters.fy
fancy-0.7.0 examples/documentation_formatters.fy
fancy-0.6.0 examples/documentation_formatters.fy
fancy-0.5.0 examples/documentation_formatters.fy
fancy-0.4.0 examples/documentation_formatters.fy
fancy-0.3.3 examples/documentation_formatters.fy
fancy-0.3.2 examples/documentation_formatters.fy
fancy-0.3.1 examples/documentation_formatters.fy
fancy-0.3.0 examples/documentation_formatters.fy