RE: [boost] [Ann]: Dox - a C++ documentation tool
Thanks for the response. Are you going to submit this as a boost tool? I am not extremely familiar with the whole documentation generation aspect of boost, so I am not sure how this would fit in. If you are planning to submit this, I suggest you: * Pay careful attention to anyone who responds to this mail who knows more about how the doc gen stuff works * "Go the last mile"- i.e. do whatever extra work needed to fully integrate this tool based on the feedback and thoughts you get (i.e. don't expect someone to do it for you) Maybe if you ran doxygen on boost, and then ran your tool on that and put it up on a web server somewhere, you could post a link here and people could see "the big picture". hope that helps in some way Brian :)
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Narech Koumar Sent: Thursday, June 09, 2005 1:57 PM To: boost@lists.boost.org Subject: Re: [boost] [Ann]: Dox - a C++ documentation tool
Hi,
disadvantage: long emails trying to decide which theme to standardize on (grin)
:)
Advantage- looks cleaner than doxygen.
Glad you like it!
QUESTION:
What tools do you depend on for the program to work? I.e. tcl, perl
etc.
What are the external dependancies?
The only external dependency is Doxygen, which is included within the distros. Naturally, under unix you need a shell (ie bash), under NT cmd.exe . Finally a web browser is required in order to be able to read the generated docs :) . That's all.
Sincerely,
- NK _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Hi,
Are you going to submit this as a boost tool?
I have nothing against it. If there is a general interest in using Dox amongst the boost community I'll gladly submit it. The question is how do I do that?
I am not extremely familiar with the whole documentation generation aspect of boost, so I am not sure how this would fit in.
If you are planning to submit this, I suggest you:
* Pay careful attention to anyone who responds to this mail who knows more about how the doc gen stuff works * "Go the last mile"- i.e. do whatever extra work needed to fully integrate this tool based on the feedback and thoughts you get (i.e. don't expect someone to do it for you)
Thanks for the suggestions.
Maybe if you ran doxygen on boost, and then ran your tool on that and put it up on a web server somewhere, you could post a link here and people could see "the big picture".
Boost is one of the regression/performance tests for Dox :) . At this point the majority of the boosts' libs can be documented as is; unfortunately there are some major eeky quirks in the current version of Doxygen which hinder boost to be documented in its entirety. The currently produced documentation of boost API is far too large for me to host (ca 60Meg of HTML). If someone has a webspace to offer I'll gladly send them a .zip, alternatively someone can run Dox locally and post the results. The following libs/directories are known to pass through Doxygen->Dox fairly unmaimed: algorithm archive assign bind dynamic_bitset filesystem format integer io iterator logic multi_array preprocessor program_options random range serialization test thread utility variant Cheers, - NK
I have web space. I'll love to host it. (I would probably end up being a heavy user.) It would be hosted under something like http://www.ominor.net/boost/docs On 6/10/05, Narech Koumar <narechk@gmail.com> wrote:
Hi,
Are you going to submit this as a boost tool?
I have nothing against it. If there is a general interest in using Dox amongst the boost community I'll gladly submit it. The question is how do I do that?
I am not extremely familiar with the whole documentation generation aspect of boost, so I am not sure how this would fit in.
If you are planning to submit this, I suggest you:
* Pay careful attention to anyone who responds to this mail who knows more about how the doc gen stuff works * "Go the last mile"- i.e. do whatever extra work needed to fully integrate this tool based on the feedback and thoughts you get (i.e. don't expect someone to do it for you)
Thanks for the suggestions.
Maybe if you ran doxygen on boost, and then ran your tool on that and put it up on a web server somewhere, you could post a link here and people could see "the big picture".
Boost is one of the regression/performance tests for Dox :) . At this point the majority of the boosts' libs can be documented as is; unfortunately there are some major eeky quirks in the current version of Doxygen which hinder boost to be documented in its entirety.
The currently produced documentation of boost API is far too large for me to host (ca 60Meg of HTML). If someone has a webspace to offer I'll gladly send them a .zip, alternatively someone can run Dox locally and post the results. The following libs/directories are known to pass through Doxygen->Dox fairly unmaimed:
algorithm archive assign bind dynamic_bitset filesystem format integer io iterator logic multi_array preprocessor program_options random range serialization test thread utility variant
Cheers,
- NK
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
-- "Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
Eric Goebelbecker wrote:
I have web space. I'll love to host it. (I would probably end up being a heavy user.)
It would be hosted under something like http://www.ominor.net/boost/docs
Great! A .zip file containing the current build of boost's HTML docs weights at around 18Meg. Alternatively I have the same docs compressed with 7zip (www.7-zip.org) at around 1MB. Which one would you like me to send you, and to what address? Cheers, - NK
I'll give 7-zip a spin. Make the file extension .zit or something so gmail doesn't strip off the attachment. On 6/12/05, Narech Koumar <narechk@gmail.com> wrote:
Eric Goebelbecker wrote:
I have web space. I'll love to host it. (I would probably end up being a heavy user.)
It would be hosted under something like http://www.ominor.net/boost/docs
Great! A .zip file containing the current build of boost's HTML docs weights at around 18Meg. Alternatively I have the same docs compressed with 7zip (www.7-zip.org) at around 1MB. Which one would you like me to send you, and to what address?
Cheers,
- NK
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
-- "Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
Eric Goebelbecker wrote:
I'll give 7-zip a spin. Make the file extension .zit or something so gmail doesn't strip off the attachment.
I posted a .7z archive to your gmail account. Please report back with results and impressions. Cheers, - NK
Got it. Should have a chance to do something tomorrow. On 6/13/05, Narech Koumar <narechk@gmail.com> wrote:
Eric Goebelbecker wrote:
I'll give 7-zip a spin. Make the file extension .zit or something so gmail doesn't strip off the attachment.
I posted a .7z archive to your gmail account. Please report back with results and impressions.
Cheers,
- NK _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
-- "Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
I apologize for the delay. This will be posted over the weekend. On 6/13/05, Eric Goebelbecker <egoebelbecker@gmail.com> wrote:
Got it. Should have a chance to do something tomorrow.
On 6/13/05, Narech Koumar <narechk@gmail.com> wrote:
Eric Goebelbecker wrote:
I'll give 7-zip a spin. Make the file extension .zit or something so gmail doesn't strip off the attachment.
I posted a .7z archive to your gmail account. Please report back with results and impressions.
Cheers,
- NK _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
--
"Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
-- "Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
The docs are up at http://www.ominor.net/boost/dox . I'm hoping to set up a method for automatically updating them in the next few weeks. On 6/17/05, Eric Goebelbecker <egoebelbecker@gmail.com> wrote:
I apologize for the delay. This will be posted over the weekend.
On 6/13/05, Eric Goebelbecker <egoebelbecker@gmail.com> wrote:
Got it. Should have a chance to do something tomorrow.
On 6/13/05, Narech Koumar <narechk@gmail.com> wrote:
Eric Goebelbecker wrote:
I'll give 7-zip a spin. Make the file extension .zit or something so gmail doesn't strip off the attachment.
I posted a .7z archive to your gmail account. Please report back with results and impressions.
Cheers,
- NK _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
--
"Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
--
"Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
-- "Should array indices start at 0 or 1? My compromise of 0.5 was rejected without, I thought, proper consideration." - Stan Kelly-Bootle ------------------------------------ Eric Goebelbecker eric@ominor.net http://eric.ominor.net
Eric Goebelbecker wrote: [snipped] Please, limit the amount of text you quote. See http://boost.org/more/discussion_policy.htm#quoting for details. Regards, m Send instant messages to your online friends http://au.messenger.yahoo.com
Eric Goebelbecker wrote:
The docs are up at http://www.ominor.net/boost/dox .
I'm hoping to set up a method for automatically updating them in the next few weeks.
Hi Eric. Great job, thanks for your efforts! I have a few comments on the documentation so far. 1) The docs are very rough at the moment, in large part due to all the macros in boost code. An attempt to force macro expansion (in Doxygen's preprocessor) is worth a try since it may give a better and "more" correct view of the docs. Doxygen's parser can get confused by certain macro declarations. 2) There are some known defects in the Sunsys Dox, one of them is filename generation. Since the current batch of docs were produced on NT (file system non-casesensitive) the link to Namespaces->std is invalid: [summary]-std.html is overwrititten by [summary]-STD.html; there may be others. 3) Judging from the produced docs the boost code seems to be largely undocumented inline. A notable ecxeption is boost::program_options namespace. 4) Finally a warning to 56K users: broadband connection is recommended! Perhaps it can be arranged so that a downloadable version of .zip:ed docs if offered to those wishing to read offline. Best regards, - Narech Koumar
participants (4)
-
Brian Braatz -
Eric Goebelbecker -
Martin Wille -
Narech Koumar