8000 GitHub - quentpilot/DocMaker: This project would to generate a personal documentation included to our projects (Java, C++, PHP,...)
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

quentpilot/DocMaker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocMaker

This program would to generate a personal, shared, advanced,... documentation included to your own projects (Java, C++, PHP,...). DocMaker should be developped in different languages such as Java (first), C++, PHP... and why not with other languages.

  • First, because I want to test advanced OOP pattern designs with differents languages, it's fun.
  • Then, to be edited by anybody who has enougth knowledge about related language. So DocMaker can be customized as you want.

Main Focuses

  • DocMaker would be able to build static/dynamic website documentation customizable as many as possible from intern database formated on differents languages like Json, SQL,... To do so, an editor will be integrated to DocMaker from command-line, Admin CMS part and/or from his own GUI software management.
  • DocMaker would to be able to generate a UNIX Man documentation following your current project.
  • DocMaker would to build a Javadoc, PHPdoc and others following your project source code.

Current Project Status

  • Language : Java
  • IDE : Eclipse
  • Doc Type : HTTP - Website

About

  • Main tree is built to focus on website documentation generator. So the biggest part.

Output

  • For now, there is only main class instanciation messages printed on the stantard output.

How to test ?

  • Open Eclipse-Java

  • Only Run project ?

    • Clone project to your workspace
    • Add and select current project repository, then Build & Run from Navigator... for example
  • Clone, commit,... Project

    • Configure your Github account from "Window Preferences > Team > Git > configuration" if you haven't done previously
    • Add Git repository from "Window > Show View > Other... > Git > Git Repositories"
    • Clone or select related local repository cloned
    • Add it as new project to any workspace you want
    • Then Select project, Build & Run

More

  • More infos on the wiki... soon.

About

This project would to generate a personal documentation included to our projects (Java, C++, PHP,...)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0