alsemyonov/xommelier Xommelier

WIP; XML←→Object mapper in Ruby with included definitions...

#13 (all)
Ruby (change)
7 seconds
over 1 year ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
Numeric N
A
String N
A
Symbol N
A
Float N
A
Xommelier Ne
Show 12 more ...
Undocumented
U
Xommelier::DS::Element.sequence! N
U
Xommelier::DS::Element.choice! N
U
Xommelier::DS::Element.any! N
U
FalseClass N
U
TrueClass N
U
Boolean N
U
Date N
U
Time N
U
Uri N
U
Xommelier::Xml::Element::Serialization::ClassMethods#from_xml N
U
Xommelier::Xml::Element::Serialization#from_xml N
U
Xommelier::Xml::Element::Serialization#to_xml N
U
Xommelier::Xml::Namespace#uri N
U
Xommelier::Xml::Element::Serialization::ClassMethods#ns_element Ne
U
Xommelier::Xml::Element::Structure::ClassMethods#many Ne
U
Xommelier::Xml::Element::Structure::ClassMethods#any Ne
U
Xommelier::Xml::Element::Structure::ClassMethods#may Ne
U
Xommelier::Xml::Element::Serialization Ne
U
Xommelier::Xml::Namespace#initialize Ne
U
Xommelier::OPML::Body#each_outline Ne
U
Xommelier::Xml::Element::Structure Ne
U
Xommelier::Xml::Namespace#scoped Ne
U
Xommelier::Xml::Element::Structure::SingletonClassMethods#element_name Ne
U
Xommelier::Xml::Element::Structure::Element#serializable_element_name Ne
U
Xommelier::Xml::Element::Serialization::ClassMethods#element_xpath Ne
U
Xommelier::Xml::Element::Serialization::ClassMethods#xmlns_xpath Ne
U
Xommelier::Xml::Element::Structure::Attribute#attribute_name Ne
U
Xommelier::Xml::Element::Structure::Element#overridden_xmlns Ne
U
Xommelier::Xml::Element::Structure::Element#plural_writer Ne
U
Xommelier::Xml::Element::Structure::SingletonClassMethods Ne
U
Xommelier::Xml::Element::Structure::Element#element_name Ne
U
Xommelier::Xml::Element::Structure::Property#initialize Ne
U
Xommelier::Xml::Element::Structure::Attribute#node_type Ne
U
Xommelier::Xml::Element::Structure::Element#node_type Ne
U
Xommelier::Xml::Element::Serialization::ClassMethods Ne
U
Xommelier::Xml::Element::Structure::Property#inspect Ne
U
Xommelier::Xml::Element::Structure::Property#default Ne
U
Xommelier::Xml::Element::Structure::Property#options Ne
U
Xommelier::Xml::Element::Structure::Element#override Ne
U
Xommelier::Xml::Element::Structure::Property#writer Ne
U
Xommelier::Xml::Element::Structure::Element#plural Ne
U
Xommelier::Xml::Element::Structure::Text#node_type Ne
U
Xommelier::Xml::Element::Structure::Element#fixed Ne
U
Xommelier::Xml::Element::Structure::Property#name Ne
U
Xommelier::Xml::Element::Namespace::ClassMethods Ne
U
Xommelier::Xml::Element::Structure::ClassMethods Ne
U
Xommelier::OpenSearch::Element.find_element_name Ne
U
Xommelier::Xml::Element::Serialization#to_hash Ne
U
Xommelier::Xml::Element::Structure::Attribute Ne
U
Xommelier::OPML::CategoryArray.from_xommelier Ne
U
Xommelier::Xml::Element::Structure::Property Ne
U
Xommelier::OPML::CategoryArray#to_xommelier Ne
U
Xommelier::Xml::Element::Structure::Element Ne
U
Xommelier::Xml::Element::Serialization#to_s Ne
U
Xommelier::Xml::Element::Serialization#<=> Ne
U
Xommelier::Xml::Element::Serialization#== Ne
U
Xommelier::Xml::Element::Serialization#=~ Ne
U
Xommelier::DS::Element.find_element_name Ne
U
Xommelier::OPML::Category.from_xommelier Ne
U
Xommelier::Xml::Namespace#attribute_name Ne
U
Xommelier::Atom::LinksExtension#html_url Ne
U
Xommelier::Atom::LinksExtension#feed_url Ne
U
Xommelier::OpenSearch::Element.attribute Ne
U
Xommelier::Xml::Element::Structure::Text Ne
U
Xommelier::Xml::Schema#schema_location= Ne
U
Xommelier::Atom::Entry#replies_feed_url Ne
U
Xommelier::OpenSearch::Element.element Ne
U
Xommelier::OPML::Category#to_xommelier Ne
U
Xommelier::Xml::Schema#schema_location Ne
U
Xommelier::RSS::EmailAddress#address= Ne
U
Xommelier::RSS::EmailAddress#address Ne
U
Xommelier::DS::Element.has_algorithm Ne
U
Xommelier::Xml::Namespace#attributes Ne
U
Xommelier::DS::CryptoBinary#inspect Ne
U
Xommelier::NoSchemaError#initialize Ne
U
Xommelier::Xml::Element::Namespace Ne
U
Xommelier::Xml::Element#initialize Ne
U
Xommelier::OPML::Element.attribute Ne
U
Xommelier::Xml::Namespace#options= Ne
U
Xommelier::RSS::EmailAddress#name= Ne
U
Xommelier::Xml::Namespace#elements Ne
U
Xommelier::Xml::Namespace#to_hash Ne
U
Xommelier::Xml::Namespace#options Ne
U
Xommelier::Xml::Namespace#inspect Ne
U
Xommelier::RSS::Element.attribute Ne
U
Xommelier::RSS::EmailAddress#name Ne
U
Xommelier::OPML::Element.element Ne
U
Xommelier::Xml::Namespace#module Ne
U
Xommelier::Atom::Feed#search_url Ne
U
Xommelier::Xml::Namespace#schema Ne
U
Xommelier::Atom::LinksExtension Ne
U
Xommelier::RSS::Element.element Ne
U
Xommelier::DS::CryptoBinary#raw Ne
U
Xommelier::Xml::Element#inspect Ne
U
Xommelier::TypeError#initialize Ne
U
Xommelier::Xml::Element#options Ne
U
Xommelier::DSIG11::ECPointType Ne
U
Xommelier::OPML::CategoryArray Ne
U
Xommelier::XmlStrategy#result Ne
U
Xommelier::Xml::ClassMethods Ne
U
Xommelier::Xml::Namespace#as Ne
U
Xommelier::Xml::Namespace#ns Ne
U
Xommelier::DS::CryptoBinary Ne
U
URI::Generic#to_xommelier Ne
U
Xommelier::Xml::Namespace Ne
U
Xommelier::OPML::Category Ne
U
Xommelier::OPML::Element Ne
U
Xommelier::OPML::Outline Ne
U
FalseClass#to_xommelier Ne
U
Xommelier::Xml::Element Ne
U
Xommelier::RSS::Element Ne
U
Xommelier::XmlStrategy Ne
U
Xommelier::DS::Element Ne
U
Boolean.from_xommelier Ne
U
TrueClass#to_xommelier Ne
U
Xommelier::Xml::Schema Ne
U
Numeric.from_xommelier Ne
U
Xommelier::Atom::Feed Ne
U
Symbol.from_xommelier Ne
U
String.from_xommelier Ne
U
Xommelier::OPML::Body Ne
U
Float.from_xommelier Ne
U
Numeric#to_xommelier Ne
U
Symbol#to_xommelier Ne
U
Time.from_xommelier Ne
U
Xommelier::RSS::Rss Ne
U
String#to_xommelier Ne
U
Date.from_xommelier Ne
U
Float#to_xommelier Ne
U
Date#to_xommelier Ne
U
Time#to_xommelier Ne
U
URI::Generic Ne
U
Xommelier::Xml::Element::Structure::SingletonClassMethods#find_element_name E
U
Xommelier::Xml::Element::Serialization#ensure_xml_document E
U
Xommelier::Xml::Element::Serialization#children_namespaces E
U
Xommelier::Xml::Element::Serialization#serialize_attribute E
U
Xommelier::Xml::Element::Structure::Property#overrides E
U
Xommelier::Xml::Element::Structure#set_default_values E
U
Xommelier::Xml::Element::Serialization#element_xpath E
U
Xommelier::Xml::Element::Serialization#xml_document E
U
Xommelier::Xml::Element::Structure#remove_attribute E
U
Xommelier::Atom::LinksExtension#detect_linked_href E
U
Xommelier::Xml::Element::Structure#write_attribute E
U
Xommelier::Xml::Element::Serialization#xmlns_xpath E
U
Xommelier::Xml::Element::Structure#read_attribute E
U
Xommelier::Xml::Element::Structure#remove_element E
U
Xommelier::Xml::Element::Structure#write_element E
U
Xommelier::Xml::Element::Structure#read_element E
U
Xommelier::Xml::Schema#_default_schema_location E
U
Xommelier::Xml::Element::Structure#element_name E
U
Xommelier::Xml::Element::Structure#remove_text E
U
Xommelier::Xml::Element::Structure#write_text E
U
Xommelier::Xml::Element::Structure#read_text E
U
Xommelier::Xml::Element::Structure#options= E
U
Xommelier::Xml::Schema#_available_schemas E
U
Xommelier::DSIG11::ECPointType.from_xommelier E
U
Xommelier::RSS::EmailAddress.from_xommelier E
U
Xommelier::DS::CryptoBinary.from_xommelier E
U
Xommelier::Common::Time822.from_xommelier E
U
Xommelier::RSS::EmailAddress#to_xommelier E
U
Xommelier::DS::CryptoBinary#to_xommelier E
U
Xommelier::Common::Time822#to_xommelier E
U
Xommelier::Xml::Element#options= E
U
Uri.from_xommelier E
U
Xommelier::Xml E

Let's raise the visibility of documentation in Open Source!

This page is for alsemyonov/xommelier and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.