hi all It seems to me (as a newcomer) that the one thing boost needs is documentation in a unified structure. I'm thinking of something along the lines of the MS .NET class library or the Java class references. The existing documentation for the libraries I have used so far are very hard to navigate - they seem to be more aimed at standards committees than end users. As an end user, the first thing I need is an easily navigated tree just listing all the namepaces, functions, classes, typedefs etc. As a start does anyone have a doxygen config file for generating a simple function list and class hierarchy? cheers Rob Agar
On 5/29/07, Rob Agar <robagar@westnet.com.au> wrote:
hi all
It seems to me (as a newcomer) that the one thing boost needs is documentation in a unified structure. I'm thinking of something along the lines of the MS .NET class library or the Java class references.
The existing documentation for the libraries I have used so far are very hard to navigate - they seem to be more aimed at standards committees than end users. As an end user, the first thing I need is an easily navigated tree just listing all the namepaces, functions, classes, typedefs etc.
There exist an ongoing effort to give Boost docs an unified look & feel. Look at: ( http://www.boost.org/doc/html/index.html ) for a pick of what may become boost docs in the future. IMHO Quickbook docs are very easy to navigate.
As a start does anyone have a doxygen config file for generating a simple function list and class hierarchy?
C++ is a different beast from Java, and the way to document the libraries is different too. I can give you the doxygen docs of my lib, Boost.Bimap. They are here: ( http://tinyurl.com/2pqytf ). But in the same way as other C++ libraries, the list of classes and functions is not the appropriate way to document it. Please look at ( http://tinyurl.com/22sja5 ) You can look for the reference there, that is not generated by doxygen. This kind of reference is the one used by other boost libraries like Boost.MultiIndex, and IMHO it is far superior to doxygen docs. We also have a "search boost" button in the principal page. I agree that It will be nice if it could be more integrated with the actual docs. Best Regards Matias
on Tue May 29 2007, "Matias Capeletto" <matias.capeletto-AT-gmail.com> wrote:
C++ is a different beast from Java, and the way to document the libraries is different too. I can give you the doxygen docs of my lib, Boost.Bimap. They are here: ( http://tinyurl.com/2pqytf ). But in the same way as other C++ libraries, the list of classes and functions is not the appropriate way to document it. Please look at ( http://tinyurl.com/22sja5 ) You can look for the reference there, that is not generated by doxygen. This kind of reference is the one used by other boost libraries like Boost.MultiIndex, and IMHO it is far superior to doxygen docs.
Wow, beautiful pictures. How did you make them? -- Dave Abrahams Boost Consulting http://www.boost-consulting.com
On 5/30/07, David Abrahams <dave@boost-consulting.com> wrote:
on Tue May 29 2007, "Matias Capeletto" <matias.capeletto-AT-gmail.com> wrote:
C++ is a different beast from Java, and the way to document the libraries is different too. I can give you the doxygen docs of my lib, Boost.Bimap. They are here: ( http://tinyurl.com/2pqytf ). But in the same way as other C++ libraries, the list of classes and functions is not the appropriate way to document it. Please look at ( http://tinyurl.com/22sja5 ) You can look for the reference there, that is not generated by doxygen. This kind of reference is the one used by other boost libraries like Boost.MultiIndex, and IMHO it is far superior to doxygen docs.
Wow, beautiful pictures. How did you make them?
With an object based image editor that lets me put shadows and apply transparencies. If you are interested I did the following logos last year, feel free to use them... * A possible Boost.Build v2 logo, based on the work of Vladimir Prus http://matias.capeletto.googlepages.com/boost.build.logo.png * A possible Quickbook logo http://matias.capeletto.googlepages.com/boost.Quickbook.logo.png * A possible Boost.Python logo http://matias.capeletto.googlepages.com/boost.python.logo.png * A possible Boost.MultiIndex logo http://matias.capeletto.googlepages.com/boost.multi_index.logo.png I will try to make more in the future if people is interested. Best Regards Matias
on Wed May 30 2007, "Matias Capeletto" <matias.capeletto-AT-gmail.com> wrote:
With an object based image editor that lets me put shadows and apply transparencies.
What is it called?
If you are interested I did the following logos last year, feel free to use them...
* A possible Boost.Build v2 logo, based on the work of Vladimir Prus http://matias.capeletto.googlepages.com/boost.build.logo.png
* A possible Quickbook logo http://matias.capeletto.googlepages.com/boost.Quickbook.logo.png
* A possible Boost.Python logo http://matias.capeletto.googlepages.com/boost.python.logo.png
* A possible Boost.MultiIndex logo http://matias.capeletto.googlepages.com/boost.multi_index.logo.png
Very pretty. -- Dave Abrahams Boost Consulting http://www.boost-consulting.com
-----Original Message----- From: boost-users-bounces@lists.boost.org [mailto:boost-users-bounces@lists.boost.org] On Behalf Of Matias Capeletto Sent: 31 May 2007 05:19 To: boost-users@lists.boost.org Subject: Re: [Boost-users] unified documentation
On 5/31/07, David Abrahams <dave@boost-consulting.com> wrote:
on Wed May 30 2007, "Matias Capeletto"
<matias.capeletto-AT-gmail.com> wrote:
With an object based image editor that lets me put
shadows and apply
transparencies.
What is it called?
PhotoImpact
You could also try Satori (www.satoripaint.com). It's getting old now, but can do most of what you see in the pictures. I'm biased of course, because I was in the team of two that wrote it, a few years ago.
Regards Matias _______________________________________________ Boost-users mailing list Boost-users@lists.boost.org http://lists.boost.org/mailman/listinfo.cgi/boost-users
This message (including any attachments) contains confidential and/or proprietary information intended only for the addressee. Any unauthorized disclosure, copying, distribution or reliance on the contents of this information is strictly prohibited and may constitute a violation of law. If you are not the intended recipient, please notify the sender immediately by responding to this e-mail, and delete the message from your system. If you have any questions about this e-mail please notify the sender immediately.
Matias Capeletto wrote:
On 5/30/07, David Abrahams <dave@boost-consulting.com> wrote:
Wow, beautiful pictures. How did you make them?
With an object based image editor that lets me put shadows and apply transparencies. If you are interested I did the following logos last year, feel free to use them...
* A possible Boost.Build v2 logo, based on the work of Vladimir Prus http://matias.capeletto.googlepages.com/boost.build.logo.png
* A possible Quickbook logo http://matias.capeletto.googlepages.com/boost.Quickbook.logo.png
I like it! Pretty! Any chance for a Fusion logo ;-) Regards, -- Joel de Guzman http://www.boost-consulting.com http://spirit.sf.net
On 5/31/07, Joel de Guzman <joel@boost-consulting.com> wrote:
Matias Capeletto wrote:
On 5/30/07, David Abrahams <dave@boost-consulting.com> wrote:
If you are interested I did the following logos last year, feel free to use them...
* A possible Boost.Build v2 logo, based on the work of Vladimir Prus http://matias.capeletto.googlepages.com/boost.build.logo.png
* A possible Quickbook logo http://matias.capeletto.googlepages.com/boost.Quickbook.logo.png
I like it! Pretty! Any chance for a Fusion logo ;-)
sure :)
I will try to make more in the future if people is interested.
Gennady:
I am trying to come up with Boost.Test logo. Any chance you can help? I've got some ideas. But I am more or less "graphically ignorant". If you up to it please contact me.
Tell me your idea an I give it a try. I have some ideas of my own about it if you are interested too. I will move this thread to Boost docs list. Best regards Matias
"Matias Capeletto" <matias.capeletto@gmail.com> wrote in message news:e9b043a10705310703k71c9cb8cy6df293761aaf13e0@mail.gmail.com...
Tell me your idea an I give it a try. I have some ideas of my own about it if you are interested too.
I'll contact you offline if you don't mind. Gennadiy
On 5/31/07, Gennadiy Rozental <gennadiy.rozental@thomson.com> wrote:
"Matias Capeletto" <matias.capeletto@gmail.com> wrote in message news:e9b043a10705310703k71c9cb8cy6df293761aaf13e0@mail.gmail.com...
Tell me your idea an I give it a try. I have some ideas of my own about it if you are interested too.
I'll contact you offline if you don't mind.
Please do it Matias
"Matias Capeletto" <matias.capeletto@gmail.com> wrote in message news:e9b043a10705301949q66266c20u727a8bcc9c00c74e@mail.gmail.com...
I will try to make more in the future if people is interested.
I am trying to come up with Boost.Test logo. Any chance you can help? I've got some ideas. But I am more or less "graphically ignorant". If you up to it please contact me. Gennadiy
Matias Capeletto wrote:
But in the same way as other C++ libraries, the list of classes and functions is not the appropriate way to document it. Please look at ( http://tinyurl.com/22sja5 )
I agree 100%. Regards, -- Joel de Guzman http://www.boost-consulting.com http://spirit.sf.net
participants (1)
-
David Abrahams -
Gennadiy Rozental -
Hughes, James -
Joel de Guzman -
Matias Capeletto -
Rob Agar