MiniOxygen

Description

MiniOxygen is a automatic documentation generator (mostly) compatible with the DOxygen/Javadoc notation written in Perl.
It outputs to Markdown format on stdout.

It is quite basic and can be used with almost any language.

Dependencies

This tool is modern Perl, which means it requires a few modules to be present on your system, like libcarp-assert-perl for example.

Usage

Basic command line is:

# minioxygen [--lang|-l language] file(s)...

Language can be any language (basic mode) or 'c' (improved mode).

As an example, MiniOxygen will parse itself with the command:

# minioxygen MiniOxygen/*.pm

Any file containing a @file tag will be parsed and its documentation will be generated.

Supported DOxygen tags

• brief
• file
• function
  • param
  • return
• def
• enum
• struct (pending)

Auto-generated documentation for MiniOxygen starts after this line

---

File/objects

• MiniOxygen::Markdown
• MiniOxygen::Render
• MiniOxygen::Source
• MiniOxygen::Token
• MiniOxygen::Input

---

MiniOxygen::Markdown

Markdown module for MiniOxygen

Definitions

Back to File/objects

Data types

Back to File/objects

Data structures

Back to File/objects

Functions

• MiniOxygen::Markdown::header
• MiniOxygen::Markdown::line
• MiniOxygen::Markdown::normal
• MiniOxygen::Markdown::bold
• MiniOxygen::Markdown::bullet
• MiniOxygen::Markdown::create_link
• MiniOxygen::Markdown::newline
• MiniOxygen::Markdown::inline_code
• MiniOxygen::Markdown::blockquote
• MiniOxygen::Markdown::code_block

Back to File/objects

---

MiniOxygen::Markdown::header

Outputs a level n header

Prototype

    MiniOxygen::Markdown::header ( level, str )

Parameters

    level : the heading level (1-n)
    str : the heading content/text

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::line

Outputs a line

Prototype

    MiniOxygen::Markdown::line (  )

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::normal

Outputs normal text

Prototype

    MiniOxygen::Markdown::normal ( str )

Parameters

    str : the text

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::bold

Outputs bold text

Prototype

    MiniOxygen::Markdown::bold ( str )

Parameters

    str : the text

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::bullet

Outputs a bullet point

Prototype

    MiniOxygen::Markdown::bullet (  )

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::create_link

Outputs a link

Prototype

    MiniOxygen::Markdown::create_link ( str )

Parameters

    str : the text of the link

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::newline

Outputs a new line

Prototype

    MiniOxygen::Markdown::newline (  )

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::inline_code

Outputs inlined code

Prototype

    MiniOxygen::Markdown::inline_code ( str )

Parameters

    str : the inlined code string

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::blockquote

Outputs a blockquote (> )

Prototype

    MiniOxygen::Markdown::blockquote ( str )

Parameters

    str : the code to quote

Back to MiniOxygen::Markdown

MiniOxygen::Markdown::code_block

Outputs a block of code

Prototype

    MiniOxygen::Markdown::code_block ( str )

Parameters

    str : the block of code

Back to MiniOxygen::Markdown

MiniOxygen::Render

Markdown rendering module for MiniOxygen

Definitions

Back to File/objects

Data types

Back to File/objects

Data structures

Back to File/objects

Functions

• MiniOxygen::Render::list_files
• MiniOxygen::Render::list_defs
• MiniOxygen::Render::def
• MiniOxygen::Render::list_enums
• MiniOxygen::Render::enum
• MiniOxygen::Render::list_functions
• MiniOxygen::Render::function
• MiniOxygen::Render::list_structs
• MiniOxygen::Render::struct

Back to File/objects

---

MiniOxygen::Render::list_files

Renders a bullet list of files contained in hash

Prototype

    MiniOxygen::Render::list_files ( hash )

Parameters

    hash : the db/hash containing all the javadoc information

Back to MiniOxygen::Render

MiniOxygen::Render::list_defs

Renders a bullet list of defs/macros

Prototype

    MiniOxygen::Render::list_defs ( array )

Parameters

    array : an array of MiniOxygen::Token objects

Back to MiniOxygen::Render

MiniOxygen::Render::def

Renders a def with details

Prototype

    MiniOxygen::Render::def ( token, parent )

Parameters

    token : a def token
    parent : the parent object name/link

Back to MiniOxygen::Render

MiniOxygen::Render::list_enums

Renders a bullet list of enums

Prototype

    MiniOxygen::Render::list_enums ( array )

Parameters

    array : an array of MiniOxygen::Token objects

Back to MiniOxygen::Render

MiniOxygen::Render::enum

Renders an enum with details

Prototype

    MiniOxygen::Render::enum ( token, parent )

Parameters

    token : an enum token
    parent : the parent object name/link

Back to MiniOxygen::Render

MiniOxygen::Render::list_functions

Renders a bullet list of functions

Prototype

    MiniOxygen::Render::list_functions ( array )

Parameters

    array : an array of MiniOxygen::Token objects

Back to MiniOxygen::Render

MiniOxygen::Render::function

Renders a function with details

Prototype

    MiniOxygen::Render::function ( token, parent )

Parameters

    token : a function token
    parent : the parent object name/link

Back to MiniOxygen::Render

MiniOxygen::Render::list_structs

Renders a bullet list of data structures

Prototype

    MiniOxygen::Render::list_structs ( array )

Parameters

    array : an array of MiniOxygen::Token objects

Back to MiniOxygen::Render

MiniOxygen::Render::struct

Renders a struct with details

Prototype

    MiniOxygen::Render::struct ( token, parent )

Parameters

    token : a struct token
    parent : the parent object name/link

Back to MiniOxygen::Render

MiniOxygen::Source

Main source code parsing module for MiniOxygen

Definitions

Back to File/objects

Data types

Back to File/objects

Data structures

Back to File/objects

Functions

• MiniOxygen::Source::new
• MiniOxygen::Source::next_token

Back to File/objects

---

MiniOxygen::Source::new

Creates a new MiniOxygen::Source object

Prototype

    MiniOxygen::Source::new ( path, lang )

Parameters

    path : the path to the source file to open/parse
    lang : the language of the source file (c, perl, ...)

Returns

    a MiniOxygen::Source object

Back to MiniOxygen::Source

MiniOxygen::Source::next_token

Gets the next MiniOxygen token from file

Prototype

    MiniOxygen::Source::next_token (  )

Returns

    a MiniOxygen::Token object

Back to MiniOxygen::Source

MiniOxygen::Token

This is the main token management module

Definitions

Back to File/objects

Data types

Back to File/objects

Data structures

Back to File/objects

Functions

• MiniOxygen::Token::new
• MiniOxygen::Token::append_text
• MiniOxygen::Token::add_keyword
• MiniOxygen::Token::c_enum
• MiniOxygen::Token::c_function
• MiniOxygen::Token::c_struct

Back to File/objects

---

MiniOxygen::Token::new

Creates a new MiniOxygen::Token object

Prototype

    MiniOxygen::Token::new (  )

Returns

    MiniOxygen::Token A Token object

Back to MiniOxygen::Token

MiniOxygen::Token::append_text

Appends some text to the token description

Prototype

    MiniOxygen::Token::append_text ( text )

Parameters

    text : text to append to the token description

Back to MiniOxygen::Token

MiniOxygen::Token::add_keyword

Adds a pair keyword/value to the token

Prototype

    MiniOxygen::Token::add_keyword ( keyword, value )

Parameters

    keyword : the keyword to add to this token
    value : the keyword associated value / string

Back to MiniOxygen::Token

MiniOxygen::Token::c_enum

Interprets a c enumeration

Prototype

    MiniOxygen::Token::c_enum ( array )

Parameters

    array : containing the enum intenrals (and more)

Back to MiniOxygen::Token

MiniOxygen::Token::c_function

Interprets a c function prototype

Prototype

    MiniOxygen::Token::c_function ( lines )

Parameters

    lines : an array containing the prototype's lines of code

Back to MiniOxygen::Token

MiniOxygen::Token::c_struct

Inteprets a c structure

Prototype

    MiniOxygen::Token::c_struct ( array )

Parameters

    array : array containtning the structure internals

Back to MiniOxygen::Token

MiniOxygen::Input

Input module for MiniOxygen

Definitions

Back to File/objects

Data types

Back to File/objects

Data structures

Back to File/objects

Functions

• MiniOxygen::Input::file_to_array
• MiniOxygen::Input::file_to_str

Back to File/objects

---

MiniOxygen::Input::file_to_array

Reads a text file and stores each line in an array

Prototype

    MiniOxygen::Input::file_to_array ( path )

Parameters

    path : the path to the file

Returns

    array an array containing one line per entry

Back to MiniOxygen::Input

MiniOxygen::Input::file_to_str

Reads a text file and stores each line in an single line

Prototype

    MiniOxygen::Input::file_to_str ( path )

Parameters

    path : the path to the file

Returns

    string a string containing the whole text file

Back to MiniOxygen::Input