Opened 14 years ago

Closed 13 years ago

#1989 closed Patches (fixed)

PropertyTree docs

Reported by: ryan.gallagher@… Owned by: kaalus
Milestone: Boost 1.39.0 Component: property_tree
Version: Boost Development Trunk Severity: Problem
Keywords: Cc: kalita@…

Description

Doc Patches for review:

Attached is a patch (proeprty_tree-doxComments.diff) that adds doxygen comments to the property tree library's public headers. This will be used by the quickbook based documentation.

Also attached is a 7z file (property_tree_docs.7z) containing quickbook files and a jamfile to build the documentation from the quickfiles + doxygen comments from the patch. This file contains a "doc" directory that should be placed in libs\property_tree. Once placed there the docs can be built by running bjam in the libs\property_tree\doc directory.

These docs are all based on the old html docs ( http://kaalus.atspace.com/ptree/doc/index.html ). Some minor grammatical fixes were made and some minor updates done due to code changes. However, these attached quickbook docs still require further update, sections removed, and could probably use some more polish and content.

Linking in with the main boost docs will need to be done in a separate change.

Attachments (3)

property_tree-doxComments.patch (64.9 KB ) - added by ryan.gallagher@… 14 years ago.
patch to property tree public headers to add doxygen comments
property_tree_docs.7z (12.0 KB ) - added by ryan.gallagher@… 14 years ago.
libs/property_tree/doc
property_tree_docs.2.7z (50.3 KB ) - added by ryan.gallagher@… 14 years ago.
quickbook documentation for libs/property_tree (with missing image)

Download all attachments as: .zip

Change History (6)

by ryan.gallagher@…, 14 years ago

patch to property tree public headers to add doxygen comments

by ryan.gallagher@…, 14 years ago

Attachment: property_tree_docs.7z added

libs/property_tree/doc

by ryan.gallagher@…, 14 years ago

Attachment: property_tree_docs.2.7z added

quickbook documentation for libs/property_tree (with missing image)

comment:1 by anonymous, 14 years ago

Milestone: Boost 1.36.0Boost 1.39.0

Will PropertyTree make it into Boost 1.39.0???

comment:2 by Alvaro, 14 years ago

You can make it illegal, but you can't make it unpopular. compra farmacia fioricet online cialis di marca tramadol com

comment:3 by Sebastian Redl, 13 years ago

Resolution: fixed
Status: newclosed

Thank you, I've applied the patch.

Note: See TracTickets for help on using tickets.