Thanks I will look at it, Curently Shmem reference is built using doxygen but this is just done following and copying other xml files from other libraries. Doxygen help is just appended as reference. I was looking something to include that directly from the xml file. Is it possible to use Doxygen #include commands in BoostBook? Another thing, can I get syntax highlighted code in BoostBook? I've seen that in some Hash documentation. Thank you for all, I will look at doxygen a bit, Ion But I was ----- Original Message ----- From: "Robert Mathews" <rmathews@envoyww.com> To: <boost@lists.boost.org> Sent: Wednesday, March 09, 2005 4:36 PM Subject: [boost] Re: [shmem] Uploaded to Vault+documentation questions+misc
"ION_G_M" <ION_G_M@terra.es> wrote in message news:aea91b051a.b051aaea91@teleline.es...
Hi James and all shmem users,
Sorry for uploading to boost files but I had some problems with file size, so I uploaded to boost files instead. In boost vault you will fine a new folder (Shmem) with 3 new files:
Shmem.2005-03-06.tar.bz2 //library Shmem.2005-03-06-doc-1.tar.bz2 //doc1 Shmem.2005-03-06-doc-2.tar.bz2 //doc2
Write now I am writing documentation with a text editor and it's just a pain. For this version, I've discovered the CDATA usage so I don't have to manually escape XML characters (<, >, &). I will have a look at Quickbook. Is there any way to "insert" a cpp file directly on the code using BoostBook/QuickBook? That would help me a lot to mantain example code without errors.
I've found Doxygen a nice tool for writing code documentation. Its easy to use, and allows you to #include fragments of source code from an external source, which is a nice feature for code documentation. It also understands and parses the C++ code, so that you can maintain links between classes and structures.
Look at doxygen.org if you're interested.
Rob.