Sha256: b5a23e45cec02a73a86d9d0ecea30d88ff1868409f32f689b845db0356511036
Contents?: true
Size: 842 Bytes
Versions: 3
Compression:
Stored size: 842 Bytes
Contents
== Metadata All Shomen documents include a `(metadata)` entry which provides information about a project in general. Shomen pulls the metadata from one of two sources. First, if there is a `.ruby` file in a project it will use the data as given. Shomen's metadata format follows the .ruby specification directly. But, if there is no `.ruby` file in a project, shomen will look for a .gemspec file and convert it (as much as is possible) to the .ruby spec for inclusion. === Using a `.ruby` File TODO === Using a `.gemspec` File TODO === Alternate Formats for Other Languages Of course, if the Shomen documentation standard is used for non-Ruby projects, then the metadata specification can vary. While Shomen is designed primarily with Ruby i8n mind, it is general enough to serve just about any object-oriented programming language.
Version data entries
3 entries across 3 versions & 2 rubygems
Version | Path |
---|---|
shomen-yard-0.1.0 | spec/01_metadata.rdoc |
shomen-0.1.1 | spec/01_metadata.rdoc |
shomen-0.1.0 | spec/01_metadata.rdoc |