Click here to Skip to main content
12,502,578 members (54,056 online)
Click here to Skip to main content
Add your own
alternative version

Stats

112.2K views
64 bookmarked
Posted

DoxyS, advanced free C++ documentation tool

, 5 Mar 2005
Rate this:
Please Sign up or sign in to vote.
C++ documentation tool inspired by MS documentation style

Introduction

DoxyS is a code documentation tool for C++/C. DoxyS strives to yield a very professional looking output, presenting the the code in a structured easy to navigate set of HTML pages. Easy to use: just navigate to the root of your code directory and type doxys.

Currently it runs on Windows and Linux, but should be quite portable.

Main features

  • Generated output reflects the code directory structure.
  • Layers of abstraction with heavy use of overview tables providing names and brief descriptions of classes, functions etc. Inspired by Microsoft documentation.
  • Wiki like syntax for writing directory level documentation and related documentation pages or even design documents.

Sample Image - Function_description.jpg

Other key features

  • Generated output reflects the code directory structure.
  • Layers of abstraction with heavy use of overview tables providing names and brief descriptions of classes, functions etc. Inspired by Microsoft documentation.
  • Wiki like syntax for writing directory level documentation and related documentation pages or even design documents.
  • Built in incremental search engine (JavaScript).
  • Various diagrams with mouse over effects to provide additional information.
  • Strong support for templates, enumerations and overloaded functions.
  • Freedom to put documentation blocks anywhere.
  • Professional output with consistent placement of special sections like: Note, See Also, Examples etc.
  • Automatic linking to known entities.
  • Can cope with very large projects.

Screenshots

Sample screenshot

Sample screenshot

Sample screenshot

Sample screenshot

Sample screenshot

Sample screenshot

Sample screenshot

Sample screenshot

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

doxys
Web Developer
Denmark Denmark
No Biography provided

You may also be interested in...

Pro
Pro

Comments and Discussions

 
QuestionExport to Wiki ?? Pin
Nitin S. Jadhav12-Dec-07 4:20
memberNitin S. Jadhav12-Dec-07 4:20 
GeneralProblem with callgraphs Pin
Saurabh.Garg6-May-06 17:07
memberSaurabh.Garg6-May-06 17:07 
GeneralRe: Problem with callgraphs [modified] Pin
spud_m7-Dec-06 20:31
memberspud_m7-Dec-06 20:31 
GeneralNew Release 0.87b Pin
doxys14-Feb-06 22:39
memberdoxys14-Feb-06 22:39 
QuestionDoxygen groups Pin
JKaminski11-Feb-06 14:38
memberJKaminski11-Feb-06 14:38 
AnswerRe: Doxygen groups Pin
doxys13-Feb-06 9:55
memberdoxys13-Feb-06 9:55 
GeneralRe: Doxygen groups Pin
JKaminski13-Feb-06 21:27
memberJKaminski13-Feb-06 21:27 
GeneralRe: Doxygen groups Pin
doxys14-Feb-06 5:55
memberdoxys14-Feb-06 5:55 
QuestionDoes not work with templates Pin
JKaminski11-Feb-06 14:35
memberJKaminski11-Feb-06 14:35 
AnswerRe: Does not work with templates Pin
doxys13-Feb-06 9:52
memberdoxys13-Feb-06 9:52 
GeneralRe: Does not work with templates Pin
JKaminski14-Feb-06 11:52
memberJKaminski14-Feb-06 11:52 
GeneralRe: Does not work with templates Pin
doxys14-Feb-06 22:30
memberdoxys14-Feb-06 22:30 
GeneralPhysicalArchitecture Pin
ErickR29-Dec-05 10:19
memberErickR29-Dec-05 10:19 
GeneralRe: PhysicalArchitecture Pin
ErickR29-Dec-05 10:22
memberErickR29-Dec-05 10:22 
GeneralRe: PhysicalArchitecture Pin
doxys30-Dec-05 6:03
memberdoxys30-Dec-05 6:03 
GeneralRe: PhysicalArchitecture Pin
ErickR30-Dec-05 7:03
memberErickR30-Dec-05 7:03 
GeneralVery Well,but... Pin
Pandele Florin25-Jul-05 3:28
memberPandele Florin25-Jul-05 3:28 
GeneralRe: Very Well,but... Pin
doxys25-Jul-05 6:35
memberdoxys25-Jul-05 6:35 
GeneralWindows security keeps freaking out Pin
CasualT9-Jun-05 15:52
memberCasualT9-Jun-05 15:52 
GeneralRe: Windows security keeps freaking out Pin
John M. Drescher9-Jun-05 16:33
memberJohn M. Drescher9-Jun-05 16:33 
GeneralRe: Windows security keeps freaking out Pin
CasualT10-Jun-05 6:40
memberCasualT10-Jun-05 6:40 
GeneralExcellent Pin
bernierm4923-May-05 4:13
memberbernierm4923-May-05 4:13 
GeneralFuture plans Pin
MarkWrobel28-Mar-05 0:59
memberMarkWrobel28-Mar-05 0:59 
GeneralRe: Future plans Pin
doxys30-Mar-05 0:01
memberdoxys30-Mar-05 0:01 
GeneralRe: Future plans Pin
Bobby Mihalca11-Apr-05 4:27
memberBobby Mihalca11-Apr-05 4:27 
GeneralGreat Stuff... Pin
Cap'n Code15-Mar-05 14:14
memberCap'n Code15-Mar-05 14:14 
GeneralRe: Great Stuff... Pin
doxys16-Mar-05 22:10
memberdoxys16-Mar-05 22:10 
Question__gc filtering? Pin
Tom112-Mar-05 4:26
memberTom112-Mar-05 4:26 
AnswerRe: __gc filtering? Pin
doxys13-Mar-05 1:34
memberdoxys13-Mar-05 1:34 
GeneralHelp file generation Pin
Abyss10-Mar-05 2:32
memberAbyss10-Mar-05 2:32 
GeneralRe: Help file generation Pin
doxys10-Mar-05 4:43
memberdoxys10-Mar-05 4:43 
GeneralExcellent Pin
John M. Drescher9-Mar-05 6:52
memberJohn M. Drescher9-Mar-05 6:52 
GeneralVERY GOOD but some hints Pin
stp8-Mar-05 1:57
memberstp8-Mar-05 1:57 
GeneralRe: VERY GOOD but some hints Pin
doxys8-Mar-05 9:08
memberdoxys8-Mar-05 9:08 
GeneralRe: VERY GOOD but some hints Pin
stp8-Mar-05 20:54
memberstp8-Mar-05 20:54 
GeneralOut of memory Pin
soundman327-Mar-05 5:19
membersoundman327-Mar-05 5:19 
GeneralRe: Out of memory Pin
doxys8-Mar-05 0:53
memberdoxys8-Mar-05 0:53 
GeneralRe: Out of memory Pin
doxys13-Mar-05 1:37
memberdoxys13-Mar-05 1:37 
GeneralDifference Pin
Franz Klein7-Mar-05 4:00
memberFranz Klein7-Mar-05 4:00 
GeneralRe: Difference Pin
mlutken8-Mar-05 0:11
membermlutken8-Mar-05 0:11 
GeneralVery good Pin
waxie7-Mar-05 1:38
memberwaxie7-Mar-05 1:38 
QuestionWhy did you fork Doxygen?? Pin
Roland Pibinger6-Mar-05 1:18
memberRoland Pibinger6-Mar-05 1:18 
AnswerRe: Why did you fork Doxygen?? Pin
Paul Selormey6-Mar-05 3:50
memberPaul Selormey6-Mar-05 3:50 
AnswerRe: Why did you fork Doxygen?? Pin
mlutken6-Mar-05 22:50
membermlutken6-Mar-05 22:50 
GeneralRe: Why did you fork Doxygen?? Pin
hgohel13-Mar-05 6:43
memberhgohel13-Mar-05 6:43 
GeneralRe: Why did you fork Doxygen?? Pin
doxys13-Mar-05 10:40
memberdoxys13-Mar-05 10:40 
GeneralGreat Work Pin
pyrokar5-Mar-05 21:15
memberpyrokar5-Mar-05 21:15 
GeneralRe: Great Work Pin
mlutken6-Mar-05 22:53
membermlutken6-Mar-05 22:53 
GeneralToo much screenshots... Pin
Uwe Keim5-Mar-05 19:58
sitebuilderUwe Keim5-Mar-05 19:58 
GeneralToo many ... Pin
Anonymous6-Mar-05 1:12
sussAnonymous6-Mar-05 1:12 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.160919.1 | Last Updated 5 Mar 2005
Article Copyright 2005 by doxys
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid