xCelerator: xCPDoc

Description

The xCPDoc xCelerator is a tool that automatically creates documentation from xCP 2.0 project files.

 

Highlights

  • Simple, easy to use command line tool

     

  • Multiple stylesheet (overview, detailed)

     

  • Can be integrated into the build pipeline so that you always have up to date documentation.

     

  • Easy to add new stylesheet

     

Release Notes

  • 2012-12-16, 0.1
    Initial Release

     

User

The target users are:

  • xCP Designers

     

  • xCP Developers

     

  • xCP Architects

     

  • Support

     

Quickstart

 

  1. Unzip xcpdoc-<version>.zip into a folder of your choice.

  2. On the command line, execute:

    xcpdoc.bat -p <your project root> -d <where you want the result> -s <stylesheet>

    Where <stylesheet> is one of overview, normal, detailed.


 

Screenshots

Full-text QueryBusiness ObjectProcess Diagram
xcpdoc_fulltext_query.pngxcpdoc_businessobject.pngxcpdoc_process_diagram.png
(Click the image to enlarge it) (Click the image to enlarge it) (Click the image to enlarge it)

 

 

Jigsaw.jpg
Return to the xCelerator 2.x Homepage