doc.json

{"(metadata)":{"source":["meta"],"authors":[{"name":"trans","email":"transfire@gmail.com"}],"copyrights":[],"requirements":[{"name":"detroit","groups":["build"],"development":null}],"dependencies":[],"alternatives":[],"conflicts":[],"repositories":[{"uri":"git://github.com/rubyworks/shomen-model.git","scm":"git","name":"upstream"}],"resources":[{"uri":"http://rubyworks.github.com/shomen-model","name":"home","type":"home"},{"uri":"http://rubydoc.info/gems/shomen-model/frames","name":"docs","type":"doc"},{"uri":"http://github.com/rubyworks/shomen-model","name":"code","type":"code"},{"uri":"http://github.com/rubyworks/shomen-model/issues","name":"bugs","type":"bugs"},{"uri":"http://groups.google.com/groups/rubyworks-mailinglist","name":"mail","type":"mail"},{"uri":"http://chat.us.freenode.net/rubyworks","name":"chat","type":"chat"}],"extra":{},"load_path":["lib"],"revision":null,"created":"2010-07-01","summary":"Ruby Models for Shomen Documentation Format","title":"Shomen Model","version":"0.1.0","name":"shomen-model","description":"Shomen defines a standard API documentaiton format for object-oriented software\n(Ruby programs in particular) which can be used by documentation interfaces, \ne.g. Hypervisor, to render API documentation. Shomen Model is a set of Ruby\nclasses the module this format, and can be used to generate Shomen documentation.","organization":"rubyworks","date":"2012-04-20","path":"(metadata)","markup":"rdoc"},"Shomen":{"!":"module","path":"Shomen","name":"Shomen","namespace":"","comment":"Shomen is an intermediary documentation model designed for documenting\nobject-oriented programming languages, particularly Ruby. The specification\nis a flat mapping, without internal referencing, suitable for storage in both\nYAML and JSON formats.","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":["Shomen::Model"],"classes":["Shomen::Metadata","Shomen::Generator"],"methods":[],"accessors":[],"files":["/lib/shomen-model.rb","/lib/shomen-model/class.rb","/lib/shomen-model/module.rb","/lib/shomen-model/script.rb","/lib/shomen-model/method.rb","/lib/shomen-model/metadata.rb","/lib/shomen-model/constant.rb","/lib/shomen-model/abstract.rb","/lib/shomen-model/document.rb","/lib/shomen-model/generator.rb","/lib/shomen-model/interface.rb","/lib/shomen-model/attribute.rb"],"tags":{}},"Shomen::Model":{"!":"module","path":"Shomen::Model","name":"Model","namespace":"Shomen","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":["Shomen::Model::Class","Shomen::Model::Module","Shomen::Model::Script","Shomen::Model::Method","Shomen::Model::Constant","Shomen::Model::AbstractPrime","Shomen::Model::Abstract","Shomen::Model::Document","Shomen::Model::Interface","Shomen::Model::Attribute"],"methods":[],"accessors":[],"files":["/lib/shomen-model/class.rb","/lib/shomen-model/module.rb","/lib/shomen-model/script.rb","/lib/shomen-model/method.rb","/lib/shomen-model/constant.rb","/lib/shomen-model/abstract.rb","/lib/shomen-model/document.rb","/lib/shomen-model/interface.rb","/lib/shomen-model/attribute.rb"],"tags":{}},"Shomen::Model::Class":{"!":"class","superclass":"Shomen::Model::Module","path":"Shomen::Model::Class","name":"Class","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Class.type","Shomen::Model::Class#superclass","Shomen::Model::Class#superclass="],"accessors":["Shomen::Model::Class#superclass"],"files":["/lib/shomen-model/class.rb"],"tags":{}},"Shomen::Model::Class.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Class.type","name":"type","namespace":"Shomen::Model::Class","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/class.rb","line":null,"source":"def self.type; 'class'; end","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Class#superclass":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Class#superclass","name":"superclass","namespace":"Shomen::Model::Class","comment":"Returns the value of attribute superclass","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"superclass","arguments":[]}],"returns":[],"file":"/lib/shomen-model/class.rb","line":null,"source":"def superclass\n  @superclass\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Class#superclass=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Class#superclass=","name":"superclass=","namespace":"Shomen::Model::Class","comment":"Sets the attribute superclass","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"superclass=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/class.rb","line":null,"source":"def superclass=(value)\n  @superclass = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute superclass to."}},"Shomen::Model::Module":{"!":"class","superclass":"Shomen::Model::Abstract","path":"Shomen::Model::Module","name":"Module","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Module.type","Shomen::Model::Module#name","Shomen::Model::Module#name=","Shomen::Model::Module#namespace","Shomen::Model::Module#namespace=","Shomen::Model::Module#comment","Shomen::Model::Module#comment=","Shomen::Model::Module#format","Shomen::Model::Module#format=","Shomen::Model::Module#includes","Shomen::Model::Module#includes=","Shomen::Model::Module#extensions","Shomen::Model::Module#extensions=","Shomen::Model::Module#constants","Shomen::Model::Module#constants=","Shomen::Model::Module#modules","Shomen::Model::Module#modules=","Shomen::Model::Module#classes","Shomen::Model::Module#classes=","Shomen::Model::Module#methods","Shomen::Model::Module#methods=","Shomen::Model::Module#accessors","Shomen::Model::Module#accessors=","Shomen::Model::Module#files","Shomen::Model::Module#files=","Shomen::Model::Module#fullname"],"accessors":["Shomen::Model::Module#name","Shomen::Model::Module#namespace","Shomen::Model::Module#comment","Shomen::Model::Module#format","Shomen::Model::Module#includes","Shomen::Model::Module#extensions","Shomen::Model::Module#constants","Shomen::Model::Module#modules","Shomen::Model::Module#classes","Shomen::Model::Module#methods","Shomen::Model::Module#accessors","Shomen::Model::Module#files"],"files":["/lib/shomen-model/module.rb"],"tags":{}},"Shomen::Model::Module.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Module.type","name":"type","namespace":"Shomen::Model::Module","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def self.type; 'module'; end","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#name":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#name","name":"name","namespace":"Shomen::Model::Module","comment":"Method's name.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def name\n  @name\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#name=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#name=","name":"name=","namespace":"Shomen::Model::Module","comment":"Method's name.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def name=(value)\n  @name = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#namespace":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#namespace","name":"namespace","namespace":"Shomen::Model::Module","comment":"Namespace of module is the path of the class or module\ncontaining this module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def namespace\n  @namespace\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#namespace=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#namespace=","name":"namespace=","namespace":"Shomen::Model::Module","comment":"Namespace of module is the path of the class or module\ncontaining this module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def namespace=(value)\n  @namespace = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#comment":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#comment","name":"comment","namespace":"Shomen::Model::Module","comment":"Comment associated with module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def comment\n  @comment\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#comment=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#comment=","name":"comment=","namespace":"Shomen::Model::Module","comment":"Comment associated with module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def comment=(value)\n  @comment = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#format","name":"format","namespace":"Shomen::Model::Module","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def format\n  @format\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#format=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#format=","name":"format=","namespace":"Shomen::Model::Module","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def format=(value)\n  @format = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#includes":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#includes","name":"includes","namespace":"Shomen::Model::Module","comment":"Mixins.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"includes","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def includes\n  @includes\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#includes=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#includes=","name":"includes=","namespace":"Shomen::Model::Module","comment":"Mixins.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"includes=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def includes=(value)\n  @includes = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#extensions":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#extensions","name":"extensions","namespace":"Shomen::Model::Module","comment":"Metaclass mixins.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"extensions","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def extensions\n  @extensions\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#extensions=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#extensions=","name":"extensions=","namespace":"Shomen::Model::Module","comment":"Metaclass mixins.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"extensions=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def extensions=(value)\n  @extensions = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#constants":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#constants","name":"constants","namespace":"Shomen::Model::Module","comment":"Constants defined within this module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"constants","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def constants\n  @constants\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#constants=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#constants=","name":"constants=","namespace":"Shomen::Model::Module","comment":"Constants defined within this module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"constants=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def constants=(value)\n  @constants = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#modules":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#modules","name":"modules","namespace":"Shomen::Model::Module","comment":"Returns the value of attribute modules","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modules","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def modules\n  @modules\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#modules=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#modules=","name":"modules=","namespace":"Shomen::Model::Module","comment":"Sets the attribute modules","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modules=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def modules=(value)\n  @modules = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute modules to."}},"Shomen::Model::Module#classes":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#classes","name":"classes","namespace":"Shomen::Model::Module","comment":"Returns the value of attribute classes","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"classes","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def classes\n  @classes\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#classes=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#classes=","name":"classes=","namespace":"Shomen::Model::Module","comment":"Sets the attribute classes","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"classes=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def classes=(value)\n  @classes = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute classes to."}},"Shomen::Model::Module#methods":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#methods","name":"methods","namespace":"Shomen::Model::Module","comment":"List of instance methods defined in the module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"methods","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def methods\n  @methods\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#methods=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#methods=","name":"methods=","namespace":"Shomen::Model::Module","comment":"List of instance methods defined in the module.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"methods=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def methods=(value)\n  @methods = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#accessors":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#accessors","name":"accessors","namespace":"Shomen::Model::Module","comment":"List of attributes.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"accessors","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def accessors\n  @accessors\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#accessors=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#accessors=","name":"accessors=","namespace":"Shomen::Model::Module","comment":"List of attributes.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"accessors=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def accessors=(value)\n  @accessors = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#files":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#files","name":"files","namespace":"Shomen::Model::Module","comment":"The files in which the module is defined.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"files","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def files\n  @files\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#files=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#files=","name":"files=","namespace":"Shomen::Model::Module","comment":"The files in which the module is defined.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"files=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"def files=(value)\n  @files = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Module#fullname":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Module#fullname","name":"fullname","namespace":"Shomen::Model::Module","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"fullname","arguments":[]}],"returns":[],"file":"/lib/shomen-model/module.rb","line":null,"source":"alias :fullname :path","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script":{"!":"class","superclass":"Shomen::Model::Document","path":"Shomen::Model::Script","name":"Script","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Script.type","Shomen::Model::Script#source","Shomen::Model::Script#source=","Shomen::Model::Script#text","Shomen::Model::Script#text=","Shomen::Model::Script#header","Shomen::Model::Script#header=","Shomen::Model::Script#footer","Shomen::Model::Script#footer=","Shomen::Model::Script#uri","Shomen::Model::Script#uri=","Shomen::Model::Script#language","Shomen::Model::Script#language=","Shomen::Model::Script#name","Shomen::Model::Script#name=","Shomen::Model::Script#path","Shomen::Model::Script#path=","Shomen::Model::Script#modified","Shomen::Model::Script#modified=","Shomen::Model::Script#mtime","Shomen::Model::Script#mtime=","Shomen::Model::Script#created","Shomen::Model::Script#created=","Shomen::Model::Script#ctime","Shomen::Model::Script#ctime=","Shomen::Model::Script#requires","Shomen::Model::Script#requires=","Shomen::Model::Script#constants","Shomen::Model::Script#constants=","Shomen::Model::Script#modules","Shomen::Model::Script#modules=","Shomen::Model::Script#classes","Shomen::Model::Script#classes=","Shomen::Model::Script#class_methods","Shomen::Model::Script#class_methods=","Shomen::Model::Script#methods","Shomen::Model::Script#methods="],"accessors":["Shomen::Model::Script#source","Shomen::Model::Script#header","Shomen::Model::Script#footer","Shomen::Model::Script#uri","Shomen::Model::Script#language","Shomen::Model::Script#name","Shomen::Model::Script#path","Shomen::Model::Script#modified","Shomen::Model::Script#created","Shomen::Model::Script#requires","Shomen::Model::Script#constants","Shomen::Model::Script#modules","Shomen::Model::Script#classes","Shomen::Model::Script#class_methods","Shomen::Model::Script#methods"],"files":["/lib/shomen-model/script.rb"],"tags":{}},"Shomen::Model::Script.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Script.type","name":"type","namespace":"Shomen::Model::Script","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def self.type; 'script'; end","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#source":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#source","name":"source","namespace":"Shomen::Model::Script","comment":"Full source code or +nil+ if not provided.","format":"rdoc","aliases":["Shomen::Model::Script#text"],"singleton":null,"interfaces":[{"signature":"source","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def source\n  @source\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#source=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#source=","name":"source=","namespace":"Shomen::Model::Script","comment":"Full source code or +nil+ if not provided.","format":"rdoc","aliases":["Shomen::Model::Script#text="],"singleton":null,"interfaces":[{"signature":"source=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def source=(value)\n  @source = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#text":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#text","name":"text","namespace":"Shomen::Model::Script","comment":"Full source code or +nil+ if not provided.\nRoute text to source.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def source\n  @source\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#text=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#text=","name":"text=","namespace":"Shomen::Model::Script","comment":"Full source code or +nil+ if not provided.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source=(value)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def source=(value)\n  @source = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#header":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#header","name":"header","namespace":"Shomen::Model::Script","comment":"TODO: Since we are making source available should we deprecate header and footer,\nor should we include it if source is excluded ?","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"header","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def header\n  @header\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#header=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#header=","name":"header=","namespace":"Shomen::Model::Script","comment":"TODO: Since we are making source available should we deprecate header and footer,\nor should we include it if source is excluded ?","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"header=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def header=(value)\n  @header = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#footer":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#footer","name":"footer","namespace":"Shomen::Model::Script","comment":"Returns the value of attribute footer","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"footer","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def footer\n  @footer\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#footer=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#footer=","name":"footer=","namespace":"Shomen::Model::Script","comment":"Sets the attribute footer","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"footer=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def footer=(value)\n  @footer = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute footer to."}},"Shomen::Model::Script#uri":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#uri","name":"uri","namespace":"Shomen::Model::Script","comment":"Source code URI.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"uri","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def uri\n  @uri\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#uri=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#uri=","name":"uri=","namespace":"Shomen::Model::Script","comment":"Source code URI.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"uri=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def uri=(value)\n  @uri = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#language":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#language","name":"language","namespace":"Shomen::Model::Script","comment":"The lanuage of the script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"language","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def language\n  @language\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#language=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#language=","name":"language=","namespace":"Shomen::Model::Script","comment":"The lanuage of the script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"language=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def language=(value)\n  @language = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#name":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#name","name":"name","namespace":"Shomen::Model::Script","comment":"File basename of script path.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def name\n  @name\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#name=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#name=","name":"name=","namespace":"Shomen::Model::Script","comment":"File basename of script path.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def name=(value)\n  @name = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#path":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#path","name":"path","namespace":"Shomen::Model::Script","comment":"Full path of script, relative to project root.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def path\n  @path\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#path=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#path=","name":"path=","namespace":"Shomen::Model::Script","comment":"Full path of script, relative to project root.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def path=(value)\n  @path = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#modified":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#modified","name":"modified","namespace":"Shomen::Model::Script","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":["Shomen::Model::Script#mtime"],"singleton":null,"interfaces":[{"signature":"modified","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modified\n  @modified\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#modified=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#modified=","name":"modified=","namespace":"Shomen::Model::Script","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":["Shomen::Model::Script#mtime="],"singleton":null,"interfaces":[{"signature":"modified=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modified=(value)\n  @modified = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#mtime":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#mtime","name":"mtime","namespace":"Shomen::Model::Script","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modified","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modified\n  @modified\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#mtime=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#mtime=","name":"mtime=","namespace":"Shomen::Model::Script","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modified=(value)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modified=(value)\n  @modified = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#created":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#created","name":"created","namespace":"Shomen::Model::Script","comment":"Time stamp when script was first created.","format":"rdoc","aliases":["Shomen::Model::Script#ctime"],"singleton":null,"interfaces":[{"signature":"created","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def created\n  @created\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#created=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#created=","name":"created=","namespace":"Shomen::Model::Script","comment":"Time stamp when script was first created.","format":"rdoc","aliases":["Shomen::Model::Script#ctime="],"singleton":null,"interfaces":[{"signature":"created=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def created=(value)\n  @created = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#ctime":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#ctime","name":"ctime","namespace":"Shomen::Model::Script","comment":"Time stamp when script was first created.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"created","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def created\n  @created\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#ctime=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#ctime=","name":"ctime=","namespace":"Shomen::Model::Script","comment":"Time stamp when script was first created.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"created=(value)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def created=(value)\n  @created = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#requires":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#requires","name":"requires","namespace":"Shomen::Model::Script","comment":"Other scripts required by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"requires","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def requires\n  @requires\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#requires=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#requires=","name":"requires=","namespace":"Shomen::Model::Script","comment":"Other scripts required by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"requires=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def requires=(value)\n  @requires = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#constants":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#constants","name":"constants","namespace":"Shomen::Model::Script","comment":"Constants defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"constants","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def constants\n  @constants\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#constants=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#constants=","name":"constants=","namespace":"Shomen::Model::Script","comment":"Constants defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"constants=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def constants=(value)\n  @constants = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#modules":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#modules","name":"modules","namespace":"Shomen::Model::Script","comment":"Modules defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modules","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modules\n  @modules\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#modules=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#modules=","name":"modules=","namespace":"Shomen::Model::Script","comment":"Modules defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modules=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def modules=(value)\n  @modules = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#classes":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#classes","name":"classes","namespace":"Shomen::Model::Script","comment":"Classes defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"classes","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def classes\n  @classes\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#classes=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#classes=","name":"classes=","namespace":"Shomen::Model::Script","comment":"Classes defined by this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"classes=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def classes=(value)\n  @classes = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#class_methods":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#class_methods","name":"class_methods","namespace":"Shomen::Model::Script","comment":"Class methods defined in this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"class_methods","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def class_methods\n  @class_methods\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#class_methods=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#class_methods=","name":"class_methods=","namespace":"Shomen::Model::Script","comment":"Class methods defined in this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"class_methods=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def class_methods=(value)\n  @class_methods = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#methods":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#methods","name":"methods","namespace":"Shomen::Model::Script","comment":"Methods defined in this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"methods","arguments":[]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def methods\n  @methods\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Script#methods=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Script#methods=","name":"methods=","namespace":"Shomen::Model::Script","comment":"Methods defined in this script.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"methods=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/script.rb","line":null,"source":"def methods=(value)\n  @methods = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method":{"!":"class","superclass":"Shomen::Model::Abstract","path":"Shomen::Model::Method","name":"Method","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Method#initialize","Shomen::Model::Method#name","Shomen::Model::Method#name=","Shomen::Model::Method#namespace","Shomen::Model::Method#namespace=","Shomen::Model::Method#comment","Shomen::Model::Method#comment=","Shomen::Model::Method#format","Shomen::Model::Method#format=","Shomen::Model::Method#singleton","Shomen::Model::Method#singleton=","Shomen::Model::Method#declarations","Shomen::Model::Method#declarations=","Shomen::Model::Method#aliases","Shomen::Model::Method#aliases=","Shomen::Model::Method#alias_for","Shomen::Model::Method#alias_for=","Shomen::Model::Method#interfaces","Shomen::Model::Method#interfaces=","Shomen::Model::Method#returns","Shomen::Model::Method#returns=","Shomen::Model::Method#raises","Shomen::Model::Method#raises=","Shomen::Model::Method#dynamic","Shomen::Model::Method#dynamic=","Shomen::Model::Method#file","Shomen::Model::Method#file=","Shomen::Model::Method#line","Shomen::Model::Method#line=","Shomen::Model::Method#source","Shomen::Model::Method#source=","Shomen::Model::Method#language","Shomen::Model::Method#language=","Shomen::Model::Method#parent","Shomen::Model::Method#to_h"],"accessors":["Shomen::Model::Method#name","Shomen::Model::Method#namespace","Shomen::Model::Method#comment","Shomen::Model::Method#format","Shomen::Model::Method#singleton","Shomen::Model::Method#declarations","Shomen::Model::Method#aliases","Shomen::Model::Method#alias_for","Shomen::Model::Method#interfaces","Shomen::Model::Method#returns","Shomen::Model::Method#raises","Shomen::Model::Method#dynamic","Shomen::Model::Method#file","Shomen::Model::Method#line","Shomen::Model::Method#source","Shomen::Model::Method#language"],"files":["/lib/shomen-model/method.rb"],"tags":{}},"Shomen::Model::Method#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#initialize","name":"initialize","namespace":"Shomen::Model::Method","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(settings={})","arguments":[{"name":"settings","default":"{}"}]}],"returns":[{"type":"Method","comment":"a new instance of Method"}],"file":"/lib/shomen-model/method.rb","line":null,"source":"def initialize(settings={})\n  super(settings)\n  @table['declarations'] ||= []\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#name":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#name","name":"name","namespace":"Shomen::Model::Method","comment":"Method's name.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def name\n  @name\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#name=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#name=","name":"name=","namespace":"Shomen::Model::Method","comment":"Method's name.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def name=(value)\n  @name = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#namespace":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#namespace","name":"namespace","namespace":"Shomen::Model::Method","comment":"Method's namespace.","format":"rdoc","aliases":["Shomen::Model::Method#parent"],"singleton":null,"interfaces":[{"signature":"namespace","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def namespace\n  @namespace\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#namespace=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#namespace=","name":"namespace=","namespace":"Shomen::Model::Method","comment":"Method's namespace.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def namespace=(value)\n  @namespace = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#comment":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#comment","name":"comment","namespace":"Shomen::Model::Method","comment":"Comment accompanying method definition.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def comment\n  @comment\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#comment=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#comment=","name":"comment=","namespace":"Shomen::Model::Method","comment":"Comment accompanying method definition.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def comment=(value)\n  @comment = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#format","name":"format","namespace":"Shomen::Model::Method","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def format\n  @format\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#format=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#format=","name":"format=","namespace":"Shomen::Model::Method","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def format=(value)\n  @format = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#singleton":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#singleton","name":"singleton","namespace":"Shomen::Model::Method","comment":"Singleton method `true` or `false/nil`.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"singleton","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def singleton\n  @singleton\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#singleton=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#singleton=","name":"singleton=","namespace":"Shomen::Model::Method","comment":"Singleton method `true` or `false/nil`.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"singleton=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def singleton=(value)\n  @singleton = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#declarations":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#declarations","name":"declarations","namespace":"Shomen::Model::Method","comment":"Delarations is a list of keywords that designates characteristics\nabout a method. Common characteristics include `reader`, `writer`\nor `accessor` if the method is defined via an attr method; `public`\n`private` or `protected` given the methods visibility; and `class`\nor `instance` given the methods scope. Default designations are\nare impled if not specifically stated, such as `public` and `instance`.\n\nUsing a declarations list simplifies the Shomen data format by allowing\ndeclarations to be freely defined, rather than creating a field for each\npossible designation possible.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"declarations","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def declarations\n  @declarations\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#declarations=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#declarations=","name":"declarations=","namespace":"Shomen::Model::Method","comment":"Delarations is a list of keywords that designates characteristics\nabout a method. Common characteristics include `reader`, `writer`\nor `accessor` if the method is defined via an attr method; `public`\n`private` or `protected` given the methods visibility; and `class`\nor `instance` given the methods scope. Default designations are\nare impled if not specifically stated, such as `public` and `instance`.\n\nUsing a declarations list simplifies the Shomen data format by allowing\ndeclarations to be freely defined, rather than creating a field for each\npossible designation possible.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"declarations=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def declarations=(value)\n  @declarations = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#aliases":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#aliases","name":"aliases","namespace":"Shomen::Model::Method","comment":"Aliases.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"aliases","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def aliases\n  @aliases\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#aliases=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#aliases=","name":"aliases=","namespace":"Shomen::Model::Method","comment":"Aliases.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"aliases=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def aliases=(value)\n  @aliases = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#alias_for":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#alias_for","name":"alias_for","namespace":"Shomen::Model::Method","comment":"Aliases.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"alias_for","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def alias_for\n  @alias_for\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#alias_for=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#alias_for=","name":"alias_for=","namespace":"Shomen::Model::Method","comment":"Aliases.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"alias_for=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def alias_for=(value)\n  @alias_for = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#interfaces":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#interfaces","name":"interfaces","namespace":"Shomen::Model::Method","comment":"Breakdown of interfaces signature, arguments, parameters, block argument\nan return values.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"interfaces","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def interfaces\n  @interfaces\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#interfaces=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#interfaces=","name":"interfaces=","namespace":"Shomen::Model::Method","comment":"Breakdown of interfaces signature, arguments, parameters, block argument\nan return values.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"interfaces=(array)","arguments":[{"name":"array"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def interfaces=(array)\n  self['interfaces'] = (\n    array.map do |settings|\n      case settings\n      when Interface\n        settings\n      else\n        Interface.new(settings)\n      end\n    end\n  )\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#returns":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#returns","name":"returns","namespace":"Shomen::Model::Method","comment":"List of possible returns types.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"returns","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def returns\n  @returns\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#returns=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#returns=","name":"returns=","namespace":"Shomen::Model::Method","comment":"List of possible returns types.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"returns=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def returns=(value)\n  @returns = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#raises":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#raises","name":"raises","namespace":"Shomen::Model::Method","comment":"List of possible raised errors.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"raises","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def raises\n  @raises\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#raises=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#raises=","name":"raises=","namespace":"Shomen::Model::Method","comment":"List of possible raised errors.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"raises=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def raises=(value)\n  @raises = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#dynamic":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#dynamic","name":"dynamic","namespace":"Shomen::Model::Method","comment":"Method generated dynamically?","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"dynamic","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def dynamic\n  @dynamic\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#dynamic=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#dynamic=","name":"dynamic=","namespace":"Shomen::Model::Method","comment":"Method generated dynamically?","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"dynamic=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def dynamic=(value)\n  @dynamic = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#file":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#file","name":"file","namespace":"Shomen::Model::Method","comment":"Filename.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"file","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def file\n  @file\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#file=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#file=","name":"file=","namespace":"Shomen::Model::Method","comment":"Filename.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"file=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def file=(value)\n  @file = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#line":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#line","name":"line","namespace":"Shomen::Model::Method","comment":"Line number.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"line","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def line\n  @line\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#line=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#line=","name":"line=","namespace":"Shomen::Model::Method","comment":"Line number.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"line=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def line=(value)\n  @line = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#source":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#source","name":"source","namespace":"Shomen::Model::Method","comment":"Source code.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def source\n  @source\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#source=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#source=","name":"source=","namespace":"Shomen::Model::Method","comment":"Source code.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def source=(value)\n  @source = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#language":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#language","name":"language","namespace":"Shomen::Model::Method","comment":"Source code language.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"language","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def language\n  @language\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#language=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#language=","name":"language=","namespace":"Shomen::Model::Method","comment":"Source code language.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"language=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def language=(value)\n  @language = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#parent":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#parent","name":"parent","namespace":"Shomen::Model::Method","comment":"Method's namespace.\nDeprecated method.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def namespace\n  @namespace\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Method#to_h":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Method#to_h","name":"to_h","namespace":"Shomen::Model::Method","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"to_h()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/method.rb","line":null,"source":"def to_h\n  h = super\n  h['!'] = 'method'\n  h['interfaces'] = (interfaces || []).map{ |s| s.to_h }\n  h\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata":{"!":"class","superclass":"Object","path":"Shomen::Metadata","name":"Metadata","namespace":"Shomen","comment":"Encapsulate metadata, which preferably comes from a .ruby file,\nbut can fallback to a gemspec.","format":"rdoc","constants":["Shomen::Metadata::PWD","Shomen::Metadata::GEMSPEC_PATTERN"],"includes":["Enumerable"],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Metadata#initialize","Shomen::Metadata#dotruby","Shomen::Metadata#gemspec","Shomen::Metadata#[]","Shomen::Metadata#size","Shomen::Metadata#each","Shomen::Metadata#to_h"],"accessors":[],"files":["/lib/shomen-model/metadata.rb"],"tags":{}},"Shomen::Metadata::PWD":{"!":"constant","path":"Shomen::Metadata::PWD","name":"PWD","namespace":"Shomen::Metadata","comment":"Present working directoty.","format":"rdoc","value":"Dir.pwd","tags":{},"files":["/lib/shomen-model/metadata.rb"]},"Shomen::Metadata::GEMSPEC_PATTERN":{"!":"constant","path":"Shomen::Metadata::GEMSPEC_PATTERN","name":"GEMSPEC_PATTERN","namespace":"Shomen::Metadata","comment":"Glob pattern for looking up gemspec.","format":"rdoc","value":"'{.gemspec,*.gemspec}'","tags":{},"files":["/lib/shomen-model/metadata.rb"]},"Shomen::Metadata#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#initialize","name":"initialize","namespace":"Shomen::Metadata","comment":"Initialize new Metadata instance.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize()","arguments":[]}],"returns":[{"type":"Metadata","comment":"a new instance of Metadata"}],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def initialize\n  @data = (\n    data = {}\n    if dotruby\n      data.merge!(YAML.load_file(dotruby))\n    elsif gemspec\n      # prefereably use dotruby library to convert,\n      # but wait until it's more mainstream\n      require 'rubygems/specification'\n      spec = ::Gem::Specification.load(gemspec)\n      data['name']        = spec.name,\n      data['title']       = spec.name.capitalize,\n      data['version']     = spec.version.to_s,\n      data['authors']     = [spec.author],\n      data['summary']     = spec.summary,\n      data['description'] = spec.description,\n      data['resources']   = {'homepage' => spec.homepage}\n    else\n      # TODO: Raise error instead ?\n      data['name'] = File.basename(Dir.pwd)\n    end\n    data['path']   = '(metadata)'\n    data['markup'] = 'rdoc'  # FIXME\n    data\n  )\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#dotruby":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#dotruby","name":"dotruby","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"dotruby()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def dotruby\n  file = File.join(PWD, '.ruby')\n  return nil unless File.exist?(file)\n  file\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#gemspec":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#gemspec","name":"gemspec","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"gemspec()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def gemspec\n  file = Dir[File.join(PWD, GEMSPEC_PATTERN)].first\n  return nil unless file && File.exist?(file)\n  file\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#[]":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#[]","name":"[]","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"[](name)","arguments":[{"name":"name"}]}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def [](name)\n  @data[name]\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#size":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#size","name":"size","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"size()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def size\n  @data.size\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#each":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#each","name":"each","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"each(&blk)","arguments":[],"block":{"name":"&blk"}}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def each(&blk)\n  @data.each(&blk)\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Metadata#to_h":{"!":"method","declarations":["instance","public"],"path":"Shomen::Metadata#to_h","name":"to_h","namespace":"Shomen::Metadata","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"to_h()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/metadata.rb","line":null,"source":"def to_h\n  @data\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant":{"!":"class","superclass":"Shomen::Model::Abstract","path":"Shomen::Model::Constant","name":"Constant","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Constant.type","Shomen::Model::Constant#name","Shomen::Model::Constant#name=","Shomen::Model::Constant#namespace","Shomen::Model::Constant#namespace=","Shomen::Model::Constant#comment","Shomen::Model::Constant#comment=","Shomen::Model::Constant#format","Shomen::Model::Constant#format=","Shomen::Model::Constant#value","Shomen::Model::Constant#value=","Shomen::Model::Constant#files","Shomen::Model::Constant#files="],"accessors":["Shomen::Model::Constant#name","Shomen::Model::Constant#namespace","Shomen::Model::Constant#comment","Shomen::Model::Constant#format","Shomen::Model::Constant#value","Shomen::Model::Constant#files"],"files":["/lib/shomen-model/constant.rb"],"tags":{}},"Shomen::Model::Constant.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Constant.type","name":"type","namespace":"Shomen::Model::Constant","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def self.type; 'constant'; end","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#name":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#name","name":"name","namespace":"Shomen::Model::Constant","comment":"Constant's basename, must start with a capitalized letter.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def name\n  @name\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#name=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#name=","name":"name=","namespace":"Shomen::Model::Constant","comment":"Constant's basename, must start with a capitalized letter.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def name=(value)\n  @name = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#namespace":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#namespace","name":"namespace","namespace":"Shomen::Model::Constant","comment":"Returns the value of attribute namespace","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def namespace\n  @namespace\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#namespace=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#namespace=","name":"namespace=","namespace":"Shomen::Model::Constant","comment":"Sets the attribute namespace","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"namespace=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def namespace=(value)\n  @namespace = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute namespace to."}},"Shomen::Model::Constant#comment":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#comment","name":"comment","namespace":"Shomen::Model::Constant","comment":"Returns the value of attribute comment","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def comment\n  @comment\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#comment=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#comment=","name":"comment=","namespace":"Shomen::Model::Constant","comment":"Sets the attribute comment","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"comment=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def comment=(value)\n  @comment = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute comment to."}},"Shomen::Model::Constant#format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#format","name":"format","namespace":"Shomen::Model::Constant","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def format\n  @format\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#format=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#format=","name":"format=","namespace":"Shomen::Model::Constant","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def format=(value)\n  @format = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#value":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#value","name":"value","namespace":"Shomen::Model::Constant","comment":"Returns the value of attribute value","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"value","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def value\n  @value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#value=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#value=","name":"value=","namespace":"Shomen::Model::Constant","comment":"Sets the attribute value","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"value=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def value=(value)\n  @value = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute value to."}},"Shomen::Model::Constant#files":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#files","name":"files","namespace":"Shomen::Model::Constant","comment":"Returns the value of attribute files","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"files","arguments":[]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def files\n  @files\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Constant#files=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Constant#files=","name":"files=","namespace":"Shomen::Model::Constant","comment":"Sets the attribute files","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"files=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/constant.rb","line":null,"source":"def files=(value)\n  @files = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute files to."}},"Hash":{"!":"class","superclass":"Object","path":"Hash","name":"Hash","namespace":"","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Hash#to_h"],"accessors":[],"files":["/lib/shomen-model/core_ext.rb"],"tags":{}},"Hash#to_h":{"!":"method","declarations":["instance","public"],"path":"Hash#to_h","name":"to_h","namespace":"Hash","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"to_h()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/core_ext.rb","line":null,"source":"def to_h\n  self\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime":{"!":"class","superclass":"Object","path":"Shomen::Model::AbstractPrime","name":"AbstractPrime","namespace":"Shomen::Model","comment":"Base class for all model classes.","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::AbstractPrime.attr_accessor","Shomen::Model::AbstractPrime.type","Shomen::Model::AbstractPrime#initialize","Shomen::Model::AbstractPrime#[]","Shomen::Model::AbstractPrime#[]=","Shomen::Model::AbstractPrime#to_h"],"accessors":[],"files":["/lib/shomen-model/abstract.rb"],"tags":{}},"Shomen::Model::AbstractPrime.attr_accessor":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::AbstractPrime.attr_accessor","name":"attr_accessor","namespace":"Shomen::Model::AbstractPrime","comment":"Models use an internal hash to store attributes instead of \nthe usual instance methods.\n\nReturns nothing.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"attr_accessor(.)","arguments":[{"name":"name"}]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def self.attr_accessor(name)\n  name = name.to_s\n  define_method(name) do\n    self[name]\n  end\n  define_method(name+'=') do |x|\n    self[name] = x\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::AbstractPrime.type","name":"type","namespace":"Shomen::Model::AbstractPrime","comment":"Module type is the \"last name\" of the module downcased.\n\nReturns String of module type.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def self.type\n  name.split('::').last.downcase\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::AbstractPrime#initialize","name":"initialize","namespace":"Shomen::Model::AbstractPrime","comment":"Initialize new instance of model.\n\nsettings - Hash of attribute settings.\n\nReturns new model instance.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(settings={})","arguments":[{"name":"settings","default":"{}"}]}],"returns":[{"type":"AbstractPrime","comment":"a new instance of AbstractPrime"}],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def initialize(settings={})\n  @table = {}\n  settings.each do |k,v|\n    s = \"#{k}=\".gsub('-','_')\n    __send__(s,v)\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime#[]":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::AbstractPrime#[]","name":"[]","namespace":"Shomen::Model::AbstractPrime","comment":"Fetch attribute.\n\nkey - String of attribute's name.\n\nReturns attribute value.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"[](key)","arguments":[{"name":"key"}]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def [](key)\n  @table[key.to_s]\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime#[]=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::AbstractPrime#[]=","name":"[]=","namespace":"Shomen::Model::AbstractPrime","comment":"Store attribute.\n\nkey   - String of attribute's name.\nvalue - Object as value of attribute.\n\nReturns attribute value.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"[]=(k,v)","arguments":[{"name":"k"},{"name":"v"}]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def []=(k,v)\n  @table[k.to_s] = v\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::AbstractPrime#to_h":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::AbstractPrime#to_h","name":"to_h","namespace":"Shomen::Model::AbstractPrime","comment":"Convert attributes to hash, including all nested object\nthat repsond to #to_h.\n\nReturns Hash of attribute's key-value pairs.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"to_h()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def to_h\n  t = {}\n  @table.each do |k,v|\n    if v.respond_to?(:to_h)\n      t[k] = v.to_h\n    else\n      t[k] = v\n    end\n  end\n  t\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract":{"!":"class","superclass":"Shomen::Model::AbstractPrime","path":"Shomen::Model::Abstract","name":"Abstract","namespace":"Shomen::Model","comment":"Abstract base class for model classes that have a type field,\ni.e. a `!` field.","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Abstract#initialize","Shomen::Model::Abstract#path","Shomen::Model::Abstract#path=","Shomen::Model::Abstract#tags","Shomen::Model::Abstract#tags=","Shomen::Model::Abstract#type"],"accessors":["Shomen::Model::Abstract#path","Shomen::Model::Abstract#tags"],"files":["/lib/shomen-model/abstract.rb"],"tags":{}},"Shomen::Model::Abstract#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#initialize","name":"initialize","namespace":"Shomen::Model::Abstract","comment":"Initialize new model instance.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(settings={})","arguments":[{"name":"settings","default":"{}"}]}],"returns":[{"type":"Abstract","comment":"a new instance of Abstract"}],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def initialize(settings={})\n  super(settings)\n  @table['!'] = self.class.type\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract#path":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#path","name":"path","namespace":"Shomen::Model::Abstract","comment":"Full path name of documentation entry.\n\nReturns String.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path","arguments":[]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def path\n  @path\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract#path=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#path=","name":"path=","namespace":"Shomen::Model::Abstract","comment":"Full path name of documentation entry.\n\nReturns String.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def path=(value)\n  @path = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract#tags":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#tags","name":"tags","namespace":"Shomen::Model::Abstract","comment":"Hash of `label => description`.\n\nReturns Hash.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"tags","arguments":[]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def tags\n  @tags\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract#tags=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#tags=","name":"tags=","namespace":"Shomen::Model::Abstract","comment":"Hash of `label => description`.\n\nReturns Hash.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"tags=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def tags=(value)\n  @tags = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Abstract#type":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Abstract#type","name":"type","namespace":"Shomen::Model::Abstract","comment":"Type of documentation entry. Valid types are `document`,\n`script`, `method`, `class_method`, `constant` and, for one\nentry only, `(metadata)`.\n\nRetuns String of documentation entry type.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/abstract.rb","line":null,"source":"def type\n  self['!']\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document":{"!":"class","superclass":"Shomen::Model::Abstract","path":"Shomen::Model::Document","name":"Document","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Document.type","Shomen::Model::Document#name","Shomen::Model::Document#name=","Shomen::Model::Document#path","Shomen::Model::Document#path=","Shomen::Model::Document#modified","Shomen::Model::Document#modified=","Shomen::Model::Document#mtime","Shomen::Model::Document#mtime=","Shomen::Model::Document#created","Shomen::Model::Document#created=","Shomen::Model::Document#ctime","Shomen::Model::Document#ctime=","Shomen::Model::Document#uri","Shomen::Model::Document#uri=","Shomen::Model::Document#text","Shomen::Model::Document#text=","Shomen::Model::Document#format","Shomen::Model::Document#format="],"accessors":["Shomen::Model::Document#name","Shomen::Model::Document#path","Shomen::Model::Document#modified","Shomen::Model::Document#created","Shomen::Model::Document#uri","Shomen::Model::Document#text","Shomen::Model::Document#format"],"files":["/lib/shomen-model/document.rb"],"tags":{}},"Shomen::Model::Document.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Document.type","name":"type","namespace":"Shomen::Model::Document","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def self.type\n  'document'\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#name":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#name","name":"name","namespace":"Shomen::Model::Document","comment":"def key=(path)\n path = '/' + path unless path[0,1] == '/'\n super(path)\nend","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def name\n  @name\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#name=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#name=","name":"name=","namespace":"Shomen::Model::Document","comment":"def key=(path)\n path = '/' + path unless path[0,1] == '/'\n super(path)\nend","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"name=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def name=(value)\n  @name = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#path":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#path","name":"path","namespace":"Shomen::Model::Document","comment":"attr_accessor :parent","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def path\n  @path\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#path=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#path=","name":"path=","namespace":"Shomen::Model::Document","comment":"attr_accessor :parent","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"path=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def path=(value)\n  @path = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#modified":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#modified","name":"modified","namespace":"Shomen::Model::Document","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":["Shomen::Model::Document#mtime"],"singleton":null,"interfaces":[{"signature":"modified","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def modified\n  @modified\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#modified=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#modified=","name":"modified=","namespace":"Shomen::Model::Document","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":["Shomen::Model::Document#mtime="],"singleton":null,"interfaces":[{"signature":"modified=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def modified=(value)\n  @modified = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#mtime":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#mtime","name":"mtime","namespace":"Shomen::Model::Document","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modified","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def modified\n  @modified\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#mtime=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#mtime=","name":"mtime=","namespace":"Shomen::Model::Document","comment":"Time stamp when script was last modifed.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"modified=(value)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def modified=(value)\n  @modified = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#created":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#created","name":"created","namespace":"Shomen::Model::Document","comment":"Time stamp when script was first created.","format":"rdoc","aliases":["Shomen::Model::Document#ctime"],"singleton":null,"interfaces":[{"signature":"created","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def created\n  @created\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#created=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#created=","name":"created=","namespace":"Shomen::Model::Document","comment":"Time stamp when script was first created.","format":"rdoc","aliases":["Shomen::Model::Document#ctime="],"singleton":null,"interfaces":[{"signature":"created=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def created=(value)\n  @created = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#ctime":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#ctime","name":"ctime","namespace":"Shomen::Model::Document","comment":"Time stamp when script was first created.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"created","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def created\n  @created\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#ctime=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#ctime=","name":"ctime=","namespace":"Shomen::Model::Document","comment":"Time stamp when script was first created.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"created=(value)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def created=(value)\n  @created = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#uri":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#uri","name":"uri","namespace":"Shomen::Model::Document","comment":"Source code URI.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"uri","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def uri\n  @uri\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#uri=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#uri=","name":"uri=","namespace":"Shomen::Model::Document","comment":"Source code URI.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"uri=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def uri=(value)\n  @uri = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#text":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#text","name":"text","namespace":"Shomen::Model::Document","comment":"Returns the value of attribute text","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"text","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def text\n  @text\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#text=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#text=","name":"text=","namespace":"Shomen::Model::Document","comment":"Sets the attribute text","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"text=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def text=(value)\n  @text = value\nend","language":"ruby","dynamic":null,"tags":{"param":"the value to set the attribute text to."}},"Shomen::Model::Document#format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#format","name":"format","namespace":"Shomen::Model::Document","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format","arguments":[]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def format\n  @format\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Document#format=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Document#format=","name":"format=","namespace":"Shomen::Model::Document","comment":"Format of comment (rdoc, markdown or plain).","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/document.rb","line":null,"source":"def format=(value)\n  @format = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator":{"!":"class","superclass":"Object","path":"Shomen::Generator","name":"Generator","namespace":"Shomen","comment":"Shared base class that can be used by generators.","format":"rdoc","constants":["Shomen::Generator::DEFAULT_FORMAT"],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Generator#force?","Shomen::Generator#format","Shomen::Generator#format=","Shomen::Generator#source","Shomen::Generator#source=","Shomen::Generator#webcvs","Shomen::Generator#webcvs=","Shomen::Generator#readme","Shomen::Generator#readme=","Shomen::Generator#markup","Shomen::Generator#markup=","Shomen::Generator#scripts","Shomen::Generator#scripts=","Shomen::Generator#documents","Shomen::Generator#documents=","Shomen::Generator#source?","Shomen::Generator#initialize","Shomen::Generator#produce_format","Shomen::Generator#to_s","Shomen::Generator#produce_yaml","Shomen::Generator#produce_json","Shomen::Generator#produce_table","Shomen::Generator#project_metadata","Shomen::Generator#force_encoding"],"accessors":["Shomen::Generator#format","Shomen::Generator#source","Shomen::Generator#webcvs","Shomen::Generator#readme","Shomen::Generator#markup","Shomen::Generator#scripts","Shomen::Generator#documents"],"files":["/lib/shomen-model/generator.rb"],"tags":{}},"Shomen::Generator::DEFAULT_FORMAT":{"!":"constant","path":"Shomen::Generator::DEFAULT_FORMAT","name":"DEFAULT_FORMAT","namespace":"Shomen::Generator","comment":"Default output format is JSON.","format":"rdoc","value":"'json'","tags":{},"files":["/lib/shomen-model/generator.rb"]},"Shomen::Generator#force?":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#force?","name":"force?","namespace":"Shomen::Generator","comment":"Is `$FORCE` set?\n\nReturn true/false.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"force?()","arguments":[]}],"returns":[{"type":"Boolean","comment":""}],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def force?\n  $FORCE\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#format","name":"format","namespace":"Shomen::Generator","comment":"Outpu format is eitehr :yaml or :json. The default is :json.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def format\n  @format\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#format=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#format=","name":"format=","namespace":"Shomen::Generator","comment":"Outpu format is eitehr :yaml or :json. The default is :json.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"format=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def format=(value)\n  @format = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#source":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#source","name":"source","namespace":"Shomen::Generator","comment":"Flag to include full source code in script entries.\n\nReturns true/false.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def source\n  @source\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#source=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#source=","name":"source=","namespace":"Shomen::Generator","comment":"Flag to include full source code in script entries.\n\nReturns true/false.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def source=(value)\n  @source = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#webcvs":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#webcvs","name":"webcvs","namespace":"Shomen::Generator","comment":"URI prefix to link to online documentation.\n\nReturns String.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"webcvs","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def webcvs\n  @webcvs\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#webcvs=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#webcvs=","name":"webcvs=","namespace":"Shomen::Generator","comment":"URI prefix to link to online documentation.\n\nReturns String.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"webcvs=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def webcvs=(value)\n  @webcvs = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#readme":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#readme","name":"readme","namespace":"Shomen::Generator","comment":"Name of README file.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"readme","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def readme\n  @readme\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#readme=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#readme=","name":"readme=","namespace":"Shomen::Generator","comment":"Name of README file.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"readme=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def readme=(value)\n  @readme = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#markup":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#markup","name":"markup","namespace":"Shomen::Generator","comment":"Markup used for comments. This is typically either :rdoc or :markdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"markup","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def markup\n  @markup\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#markup=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#markup=","name":"markup=","namespace":"Shomen::Generator","comment":"Markup used for comments. This is typically either :rdoc or :markdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"markup=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def markup=(value)\n  @markup = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#scripts":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#scripts","name":"scripts","namespace":"Shomen::Generator","comment":"List of scripts to document.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"scripts","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def scripts\n  @scripts\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#scripts=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#scripts=","name":"scripts=","namespace":"Shomen::Generator","comment":"List of scripts to document.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"scripts=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def scripts=(value)\n  @scripts = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#documents":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#documents","name":"documents","namespace":"Shomen::Generator","comment":"List of \"information documents\" to document.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"documents","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def documents\n  @documents\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#documents=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#documents=","name":"documents=","namespace":"Shomen::Generator","comment":"List of \"information documents\" to document.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"documents=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def documents=(value)\n  @documents = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#source?":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#source?","name":"source?","namespace":"Shomen::Generator","comment":"Include source code in scripts?\n\nReturns true/false.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"source?()","arguments":[]}],"returns":[{"type":"Boolean","comment":""}],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def source?\n  @soruce\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#initialize":{"!":"method","declarations":["instance","private"],"path":"Shomen::Generator#initialize","name":"initialize","namespace":"Shomen::Generator","comment":"Initialize new generator.\n\noptions - Hash of generator options.\n\nReturns Generator instance.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(options)","arguments":[{"name":"options"}]}],"returns":[{"type":"Generator","comment":"a new instance of Generator"}],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def initialize(options)\n  @format     = DEFAULT_FORMAT\n  @readme     = Dir['README*'].first\n  @source     = false\n  @use_cache  = false\n  @markup     = nil\n  @scripts    = []\n  @documents  = []\n\n  options.each do |k,v|\n    __send__(\"#{k}=\", v)\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#produce_format":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#produce_format","name":"produce_format","namespace":"Shomen::Generator","comment":"Produce documentation in YAML or JSON format depending\non the setting of #format setting.\n\nReturns String of either YAML or JSON.","format":"rdoc","aliases":["Shomen::Generator#to_s"],"singleton":null,"interfaces":[{"signature":"produce_format()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def produce_format\n  case format.to_sym\n  when :yaml\n    produce_yaml\n  else\n    produce_json\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#to_s":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#to_s","name":"to_s","namespace":"Shomen::Generator","comment":"Produce documentation in YAML or JSON format depending\non the setting of #format setting.\n\nReturns String of either YAML or JSON.\nAlias for #produce_format.\n\nReturns String of either YAML or JSON.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"produce_format()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def produce_format\n  case format.to_sym\n  when :yaml\n    produce_yaml\n  else\n    produce_json\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#produce_yaml":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#produce_yaml","name":"produce_yaml","namespace":"Shomen::Generator","comment":"Documentation table in YAML format.\n\nReturns String of YAML.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"produce_yaml()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def produce_yaml\n  produce_table.to_yaml\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#produce_json":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#produce_json","name":"produce_json","namespace":"Shomen::Generator","comment":"Documentation table in JSON format.\n\nReturns String of JSON.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"produce_json()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def produce_json\n  force_encoding(produce_table).to_json\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#produce_table":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#produce_table","name":"produce_table","namespace":"Shomen::Generator","comment":"Generates documentation table using rdoc or yard \ndepending on the `adapter` setting.\n\nReturns documentation table. [Hash]","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"produce_table()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def produce_table\n  generate\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#project_metadata":{"!":"method","declarations":["instance","public"],"path":"Shomen::Generator#project_metadata","name":"project_metadata","namespace":"Shomen::Generator","comment":"Project metadata.\n\nReturns Metadata instance.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"project_metadata()","arguments":[]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def project_metadata\n  @project_metadata ||= Shomen::Metadata.new\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Generator#force_encoding":{"!":"method","declarations":["instance","private"],"path":"Shomen::Generator#force_encoding","name":"force_encoding","namespace":"Shomen::Generator","comment":"Force encoding to UTF-8.\n\nvalue - Common core object.\n\nReturns object with values encoded to UTF-8.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"force_encoding(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/generator.rb","line":null,"source":"def force_encoding(value)\n  case value\n  when Time,Date\n    value = value.dup if value.frozen?\n    value.to_s.force_encoding('UTF-8')\n  when String\n    value = value.dup if value.frozen?\n    value.force_encoding('UTF-8')\n  when Array\n    value.map{ |v| force_encoding(v) }\n  when Hash\n    new = {}\n    value.each do |k,v|\n      k = force_encoding(k)\n      v = force_encoding(v)\n      new[k] = v\n    end\n    new\n  end\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface":{"!":"class","superclass":"Shomen::Model::AbstractPrime","path":"Shomen::Model::Interface","name":"Interface","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Interface#initialize","Shomen::Model::Interface#signature","Shomen::Model::Interface#signature=","Shomen::Model::Interface#arguments","Shomen::Model::Interface#arguments=","Shomen::Model::Interface#parameters","Shomen::Model::Interface#parameters=","Shomen::Model::Interface#block","Shomen::Model::Interface#block=","Shomen::Model::Interface#returns","Shomen::Model::Interface#returns="],"accessors":["Shomen::Model::Interface#signature","Shomen::Model::Interface#arguments","Shomen::Model::Interface#parameters","Shomen::Model::Interface#block","Shomen::Model::Interface#returns"],"files":["/lib/shomen-model/interface.rb"],"tags":{}},"Shomen::Model::Interface#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#initialize","name":"initialize","namespace":"Shomen::Model::Interface","comment":"TODO: validate that there is an interface image.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(settings={})","arguments":[{"name":"settings","default":"{}"}]}],"returns":[{"type":"Interface","comment":"a new instance of Interface"}],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def initialize(settings={})\n  #@table = {'arguments'=>[], 'parameters'=>[]}\n  super(settings)\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#signature":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#signature","name":"signature","namespace":"Shomen::Model::Interface","comment":"The source code \"image\" of the method's inteface.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"signature","arguments":[]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def signature\n  @signature\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#signature=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#signature=","name":"signature=","namespace":"Shomen::Model::Interface","comment":"The source code \"image\" of the method's inteface.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"signature=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def signature=(value)\n  @signature = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#arguments":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#arguments","name":"arguments","namespace":"Shomen::Model::Interface","comment":"Arguments breakdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"arguments","arguments":[]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def arguments\n  @arguments\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#arguments=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#arguments=","name":"arguments=","namespace":"Shomen::Model::Interface","comment":"Arguments breakdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"arguments=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def arguments=(value)\n  @arguments = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#parameters":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#parameters","name":"parameters","namespace":"Shomen::Model::Interface","comment":"Parameters breakdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"parameters","arguments":[]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def parameters\n  @parameters\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#parameters=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#parameters=","name":"parameters=","namespace":"Shomen::Model::Interface","comment":"Parameters breakdown.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"parameters=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def parameters=(value)\n  @parameters = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#block":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#block","name":"block","namespace":"Shomen::Model::Interface","comment":"Block","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"block","arguments":[]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def block\n  @block\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#block=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#block=","name":"block=","namespace":"Shomen::Model::Interface","comment":"Block","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"block=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def block=(value)\n  @block = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#returns":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#returns","name":"returns","namespace":"Shomen::Model::Interface","comment":"Return value.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"returns","arguments":[]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def returns\n  @returns\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Interface#returns=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Interface#returns=","name":"returns=","namespace":"Shomen::Model::Interface","comment":"Return value.","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"returns=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/interface.rb","line":null,"source":"def returns=(value)\n  @returns = value\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Attribute":{"!":"class","superclass":"Shomen::Model::Method","path":"Shomen::Model::Attribute","name":"Attribute","namespace":"Shomen::Model","comment":"","format":"rdoc","constants":[],"includes":[],"extensions":[],"modules":[],"classes":[],"methods":["Shomen::Model::Attribute.type","Shomen::Model::Attribute#initialize","Shomen::Model::Attribute#rw","Shomen::Model::Attribute#rw="],"accessors":["Shomen::Model::Attribute#rw"],"files":["/lib/shomen-model/attribute.rb"],"tags":{}},"Shomen::Model::Attribute.type":{"!":"method","declarations":["class","public"],"path":"Shomen::Model::Attribute.type","name":"type","namespace":"Shomen::Model::Attribute","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"type(.)","arguments":[]}],"returns":[],"file":"/lib/shomen-model/attribute.rb","line":null,"source":"def self.type; 'attribute'; end","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Attribute#initialize":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Attribute#initialize","name":"initialize","namespace":"Shomen::Model::Attribute","comment":"","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"initialize(settings={})","arguments":[{"name":"settings","default":"{}"}]}],"returns":[{"type":"Attribute","comment":"a new instance of Attribute"}],"file":"/lib/shomen-model/attribute.rb","line":null,"source":"def initialize(settings={})\n  super(settings)\n  self['!'] = settings['singleton'] ? 'class-attribute' : 'attribute'\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Attribute#rw":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Attribute#rw","name":"rw","namespace":"Shomen::Model::Attribute","comment":"'R', 'W' or 'RW'","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"rw","arguments":[]}],"returns":[],"file":"/lib/shomen-model/attribute.rb","line":null,"source":"def rw\n  @rw\nend","language":"ruby","dynamic":null,"tags":{}},"Shomen::Model::Attribute#rw=":{"!":"method","declarations":["instance","public"],"path":"Shomen::Model::Attribute#rw=","name":"rw=","namespace":"Shomen::Model::Attribute","comment":"'R', 'W' or 'RW'","format":"rdoc","aliases":[],"singleton":null,"interfaces":[{"signature":"rw=(value)","arguments":[{"name":"value"}]}],"returns":[],"file":"/lib/shomen-model/attribute.rb","line":null,"source":"def rw=(value)\n  @rw = value\nend","language":"ruby","dynamic":null,"tags":{}},"/lib/shomen-model.yml":{"!":"document","path":"lib/shomen-model.yml","name":"shomen-model.yml","modified":"2012-04-20 11:01:37 -0400","created":"2012-04-20 11:01:37 -0400","text":"---\nsource:\n- meta\nauthors:\n- name: trans\n  email: transfire@gmail.com\ncopyrights: []\nrequirements:\n- name: detroit\n  groups:\n  - build\n  development: true\ndependencies: []\nalternatives: []\nconflicts: []\nrepositories:\n- uri: git://github.com/rubyworks/shomen-model.git\n  scm: git\n  name: upstream\nresources:\n- uri: http://rubyworks.github.com/shomen-model\n  name: home\n  type: home\n- uri: http://rubydoc.info/gems/shomen-model/frames\n  name: docs\n  type: doc\n- uri: http://github.com/rubyworks/shomen-model\n  name: code\n  type: code\n- uri: http://github.com/rubyworks/shomen-model/issues\n  name: bugs\n  type: bugs\n- uri: http://groups.google.com/groups/rubyworks-mailinglist\n  name: mail\n  type: mail\n- uri: http://chat.us.freenode.net/rubyworks\n  name: chat\n  type: chat\nextra: {}\nload_path:\n- lib\nrevision: 0\ncreated: '2010-07-01'\nsummary: Ruby Models for Shomen Documentation Format\ntitle: Shomen Model\nversion: 0.1.0\nname: shomen-model\ndescription: ! \"Shomen defines a standard API documentaiton format for object-oriented\n  software\\n(Ruby programs in particular) which can be used by documentation interfaces,\n  \\ne.g. Hypervisor, to render API documentation. Shomen Model is a set of Ruby\\nclasses\n  the module this format, and can be used to generate Shomen documentation.\"\norganization: rubyworks\ndate: '2012-04-20'\n","format":"text/plain"},"/lib/shomen-model.rb":{"!":"script","path":"lib/shomen-model.rb","name":"shomen-model.rb","created":"2012-04-20 10:29:37 -0400","modified":"2012-04-20 10:29:37 -0400"},"/lib/shomen-model/module.rb":{"!":"script","path":"lib/shomen-model/module.rb","name":"module.rb","created":"2012-04-20 10:31:15 -0400","modified":"2012-04-20 10:31:15 -0400"},"/lib/shomen-model/core_ext.rb":{"!":"script","path":"lib/shomen-model/core_ext.rb","name":"core_ext.rb","created":"2012-04-20 10:10:58 -0400","modified":"2012-04-19 08:57:36 -0400"},"/lib/shomen-model/interface.rb":{"!":"script","path":"lib/shomen-model/interface.rb","name":"interface.rb","created":"2012-04-20 10:30:50 -0400","modified":"2012-04-20 10:30:50 -0400"},"/lib/shomen-model/class.rb":{"!":"script","path":"lib/shomen-model/class.rb","name":"class.rb","created":"2012-04-20 10:30:28 -0400","modified":"2012-04-20 10:30:28 -0400"},"/lib/shomen-model/metadata.rb":{"!":"script","path":"lib/shomen-model/metadata.rb","name":"metadata.rb","created":"2012-03-23 14:14:35 -0400","modified":"2012-03-23 14:14:35 -0400"},"/lib/shomen-model/attribute.rb":{"!":"script","path":"lib/shomen-model/attribute.rb","name":"attribute.rb","created":"2012-04-20 10:30:32 -0400","modified":"2012-04-20 10:30:32 -0400"},"/lib/shomen-model/generator.rb":{"!":"script","path":"lib/shomen-model/generator.rb","name":"generator.rb","created":"2012-04-20 10:33:32 -0400","modified":"2012-04-20 10:33:32 -0400"},"/lib/shomen-model/abstract.rb":{"!":"script","path":"lib/shomen-model/abstract.rb","name":"abstract.rb","created":"2012-04-20 10:29:21 -0400","modified":"2012-04-20 10:29:21 -0400"},"/lib/shomen-model/document.rb":{"!":"script","path":"lib/shomen-model/document.rb","name":"document.rb","created":"2012-04-20 10:30:46 -0400","modified":"2012-04-20 10:30:46 -0400"},"/lib/shomen-model/script.rb":{"!":"script","path":"lib/shomen-model/script.rb","name":"script.rb","created":"2012-04-20 10:31:19 -0400","modified":"2012-04-20 10:31:19 -0400"},"/lib/shomen-model/constant.rb":{"!":"script","path":"lib/shomen-model/constant.rb","name":"constant.rb","created":"2012-04-20 10:30:23 -0400","modified":"2012-04-20 10:30:23 -0400"},"/lib/shomen-model/method.rb":{"!":"script","path":"lib/shomen-model/method.rb","name":"method.rb","created":"2012-04-20 10:31:03 -0400","modified":"2012-04-20 10:31:03 -0400"},"/README.md":{"!":"document","path":"README.md","name":"README.md","modified":"2012-03-07 19:51:24 -0500","created":"2012-03-07 19:51:24 -0500","text":"# Shomen\n\n[Website](http://rubyworks.github.com/shomen) /\n[User Manual](http://github.com/rubyworks/shomen/wiki) /\n[Development](http://github.com/rubyworks/shomen) /\n[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /\n[IRC Channel](http://chat.us.freenode.net/rubyworks)\n\n\n## Description\n\nShomen is an intermediary documentation model designed for documenting\nobject-oriented programming languages, particularly Ruby. The specification\nis a flat mapping, without internal referencing, suitable for storage in both\nYAML and JSON formats.\n\n\n## Why?\n\nBy using a standard intermediary format, documentation parsers need only concern\nthemselves with a single output target. And documentation templates in turn only\nneed to concern themselves with a single input format regardless of the parsing\nsystem that was used to generate it.\n\n\n## Features\n\n* Update a single portable file to update documentation.\n* Site disc footprint is extra small thanks to CDNs.\n* Personalize site design to best fit your project.\n* Test drive others customizations with your own remote docs!\n\n\n## Instructions\n\nTo learn about Shomen in detail please visit:\n\n* [User Manual](http://github.com/rubyworks/shomen/wiki)\n* [API Documentation](http://rubyworks.github.com/shomen)\n\nOverall usage consists of generating a Shomen documentation file for a\nproject. Typical usage looks something like:\n\n  $ shomen -R -r README.rdoc lib - [A-Z]*.* > doc.json\n\nNext you want to pair up your doc.json file with a viewer. Currently that means\nusing one of the following:\n\n* [HyperVisor](http://github.com/rubyworks/hypervisor)\n* [Rebecca](http://github.com/rubyworks/rebecca)\n* [Rubyfaux](http://github.com/rubyworks/rubyfaux)\n\nYou can copy any of those repos to your website (e.g. site/) and run with it.\nIf you want to try it out locally, we recommend using [thin](http://code.macournoyer.com/thin/)\nto view the site.\n\n    $ cd site\n    $ thin start -A file\n\nIf you can't use thin, Shomen provides a simplistic rack-based static server\nwhich can be used.\n\n    $ cd site\n    $ shomen-server\n\nViewers don't necessarily need to be copied. All three above can take\na `doc={url-to-shomen-json-file}` http parameter and server up the docs remotely.\nYou just need to publish your `doc.json` file to a publicly accessible URL.\nNote, I recommend that in this case you name the file more specifically,\ne.g. `myapp-1.0.0.json`.\n\nSee the viewer projects for more information.\n\n\n## Copying\n\nCopyright (c) 2010 Rubyworks\n\nShomen is distributed under the terms of the **BSD-2-Clause** license.\n\nSee License.txt for license details.\n\n","format":"text/markdown"}}