kit-doc edge

Docstring module
Kit::Doc::Services::Docstring

View Source

Namespace for Docstring related operations.

Link to this section Summary ⚠️ Private APIs are currently hidden.

Defined in: lib/kit/doc/services/docstring.rb#2

Get full "Docstring" for `object`.

Generate a "Table of Content" `hash` based on html headers (h1 / h2 / h3 / etc).

Generate an html "Table of Content".

Flatten the DOM headers hierarchy recursively.

Get `Docstring` summary for `object`.

Get a hash table of content for a given object.

Get full "Docstring" for object.

Generate a "Table of Content" hash based on html headers (h1 / h2 / h3 / etc)

Only the two first levels are used by the template.

Generate an html "Table of Content".

APIPrivate

⚠️ This method is part of a private API. You should avoid using it as it may be removed or be changed in the future.

Flatten the DOM headers hierarchy recursively

Get Docstring summary for object.

Get a hash table of content for a given object.