Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Generate POD-like documentation from embedded comments in JavaScript, Java, C, C++ source

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 assets
Octocat-spinner-32 bin
Octocat-spinner-32 eg
Octocat-spinner-32 lib
Octocat-spinner-32 t
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Changes
Octocat-spinner-32 GNUmakefile
Octocat-spinner-32 README
Octocat-spinner-32 css
Octocat-spinner-32 dzpl
Octocat-spinner-32 script
Octocat-spinner-32 tt
README
NAME
    Doc::Simply - Generate POD-like documentation from embedded comments in
    JavaScript, Java, C, C++ source

VERSION
    version 0.032

SYNOPSIS
        doc-simply < source.js > documentation.html

        doc-simply --help

DESCRIPTION
    Doc::Simply is bundled with "doc-simply", a commandline application that
    transforms (special) comments into documentation

    It is modeled after Plain Old Documentation but it is not an exact mimic

OVERVIEW
        * The input document is expected to have JavaScript, Java, C, C++-style comments: /* ... */ // ...
        * The output document is HTML
        * The markup style is POD-like, e.g. =head1, =head2, =body, ...
        * The formatting style is Markdown (instead of the usual C<>, L<>, ...)

Example JavaScript document
        /* 
         * @head1 NAME
         *
         * Calculator - Add 2 + 2 and return the result
         *
         */

        // @head1 DESCRIPTION
        // @body Add 2 + 2 and return the result (which should be 4)

        /*
         * @head1 FUNCTIONS
         *
         * @head2 twoPlusTwo
         *
         * Add 2 and 2 and return 4
         *
         */

        function twoPlusTwo() {
            return 2 + 2; // Should return 4
        }

SEE ALSO
    Text::Markdown

    <http://daringfireball.net/projects/markdown/syntax>

SOURCE
    You can contribute or fork this project via GitHub:

    <http://github.com/robertkrimen/Doc-Simply/tree/master>

        git clone git://github.com/robertkrimen/Doc-Simply.git Doc-Simply

AUTHOR
      Robert Krimen <robertkrimen@gmail.com>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2010 by Robert Krimen.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.

Something went wrong with that request. Please try again.