Code Monkey home page Code Monkey logo

html-doc-gen's Introduction

HTML-Doc-Gen

Documentation generator for C projects. The generator works by scraping the header files in the include folder for the functions available to the program. The generator then creates a new html file for each header file, and for each function with the files. The program will scrape any description of the functions from the header and put into a description section of the relevant html files.

Usage

When running the program it will ask for 3 inputs. First it will ask for the directory location of the project folder, this should be entered as follows:

C:/.../project

It will then ask for the location of the header files, typically this is a separate folder and should be input as:

/include

Finally it will ask for the location of the output documentation. This can be any directory, however, it is recommended to keep documentation with the project. eg:

C:/.../project/docs

The program will then scrape the function names from each header file, along with any description following the function name.

Header file formatting

To get maximum worth from the program, it is recommended that each function is given the full description expected to appear in the documentation. Each new description line should start with the // comment signature, not /* .... */

html-doc-gen's People

Contributors

volumetric-nanometre avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.