[Boost-commit] svn:boost r68619 - in sandbox/guild/mylibrary: . boost boost/mylibrary libs libs/mylibrary libs/mylibrary/doc

Subject: [Boost-commit] svn:boost r68619 - in sandbox/guild/mylibrary: . boost boost/mylibrary libs libs/mylibrary libs/mylibrary/doc
From: pbristow_at_[hidden]
Date: 2011-02-03 07:12:28

Author: pbristow
Date: 2011-02-03 07:12:26 EST (Thu, 03 Feb 2011)
New Revision: 68619
URL: http://svn.boost.org/trac/boost/changeset/68619

Log:
my template template draft
Added:
   sandbox/guild/mylibrary/
   sandbox/guild/mylibrary/boost/
   sandbox/guild/mylibrary/boost/mylibrary/
   sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp   (contents, props changed)
   sandbox/guild/mylibrary/libs/
   sandbox/guild/mylibrary/libs/mylibrary/
   sandbox/guild/mylibrary/libs/mylibrary/doc/
   sandbox/guild/mylibrary/libs/mylibrary/doc/AutoDoxywarnings.log   (contents, props changed)
   sandbox/guild/mylibrary/libs/mylibrary/doc/autodoc.xml   (contents, props changed)

Added: sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp
==============================================================================
--- (empty file)
+++ sandbox/guild/mylibrary/boost/mylibrary/mylibrary.hpp	2011-02-03 07:12:26 EST (Thu, 03 Feb 2011)
@@ -0,0 +1,129 @@
+//
+// Distributed under the Boost Software License, Version 1.0. (See
+// accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt)
+//
+// See http://www.boost.org for updates, documentation, and revision history.
+
+#ifndef BOOST_MYLIBRARY_HPP
+#define BOOST_MYLIBRARY_HPP
+
+#include <boost/config.hpp>  // for workarounds.
+
+/*!
+  \file
+  \brief Template for Boost documentation.
+  \details Header file for use by example.
+  Also using Quickbook, Doxygen and indexed by Auto-index.
+
+ \mainpage QuickBook Auto Doxygen Indexed Main page.
+This is the front page of the QuickBook Auto Doxygen Indexed
+example of producing Boost documentation.
+
+\n It is redundant for production of html and pdf output,
+but useful to allow just Doxygen manuals (no Quickbook or indexing).
+
+These can provide a more convenient compact index of the classes, files, namespaces and functions.
+They provide the Doxygen comments, but not the text from Quickbook.
+
+These manuals are quickly produced using the Doxywizard GUI frontend.
+A suitable doxyfile holding the list of files to include etc
+is conveniently placed in a /doc/doxygen sub-folder.
+Selecting this as the working directory from which doxygen will run as Step 1,
+and the run tab, and "run doxygen' in Step 2 should generate an html in the /doxygen sub-folder.
+
+The mainpage should give a pointer to the full html and/or pdf versions that provide the full Quickbook generated information.
+
+http://www.boost.org/doc/libs/my_library/index.html My Library Manual
+
+*/
+
+namespace boost
+{
+  namespace mylibrary
+  {
+   //! \brief A test class - a comment description that preceeds the class.
+  class myclass
+  { /*! \details \class myclass
+    More details on a class by comment that is tucked in under the class
+    (to reduce the line count).
+    BUT you must explicitly link to the class or it will be applied to the next member.
+    using a < doesn't work for classes as it does for members.
+    If the Doxygen comment goes over a few lines,
+    it is more convenient to use C style.
+  */
+    public:
+      //! An enum.
+      /*! More detailed enum description.
+         needing more than one line so using C style comment markers. */
+      enum test_enum {
+                   test_enum_val1, //!< Enum value TVal1 (not the < to link to the same line).
+                   test_enum_val2, //!< Enum value TVal2.
+                   test_enum_val3  /*!< Enum value TVal3. (using C style comment markers).*/
+                 };
+
+      //! A constructor.
+      /*!
+        A more elaborate description of the constructor.
+        \warning This constructor does nothing much.
+      */
+      myclass();
+
+      //! A destructor.
+      /*!
+        A more elaborate description of the destructor.
+        \warning This destructor may explode in your face!
+      */
+     ~myclass();
+
+      //! A normal member function taking two arguments and returning an integer value.
+      /*!
+        \param a an integer argument.
+        \param s a constant character pointer.
+        \return The test result.
+        \sa Test(), ~Test(), testMeToo() and publicVar()
+      */
+      int test_me(int a, const char *s);
+
+      //! A pure virtual member with descriptions of parameters.
+      //! And a 'see also' reference to another version of the function.
+      /*!
+        \see test_me()
+        \param c1 the first argument.
+        \param c2 the second argument.
+      */
+      virtual void test_me_too(char c1, char c2) = 0;
+
+      //! A public variable.
+      /*!
+        Details about the variable.
+      */
+      int mypublic_var; //!< My public class variable.
+
+
+      private:
+       int myprivate_var; //!< My private class variable.
+
+  }; // class myclass
+
+  int donowt(int i)
+  { /*! Non-member free function that does nowt useful at all.
+
+      \param i is an argument that is ignored completely.
+
+      \returns -1 always
+     \pre No preconditions.
+     \post No side effects.
+
+  */
+    return -1;
+  } //   int donowt(int i)
+
+
+
+} // namespace mylibrary
+
+} // namespace boost
+
+#endif
+#define BOOST_MYLIBRARY_HPP

Added: sandbox/guild/mylibrary/libs/mylibrary/doc/AutoDoxywarnings.log
==============================================================================

Added: sandbox/guild/mylibrary/libs/mylibrary/doc/autodoc.xml
==============================================================================
--- (empty file)
+++ sandbox/guild/mylibrary/libs/mylibrary/doc/autodoc.xml	2011-02-03 07:12:26 EST (Thu, 03 Feb 2011)
@@ -0,0 +1,13 @@
+<?xml version="1.0" standalone="yes"?>
+<library-reference id="boost_mylibrary_c___reference"><title>Boost.mylibrary C++ Reference</title><header name="boost/mylibrary/mylibrary.hpp"><para>Template for Boost documentation. </para><para>Header file for use by example. Also using Quickbook, Doxygen and indexed by Auto-index. </para><namespace name="boost"><namespace name="mylibrary"><class name="myclass"><purpose>A test class - a comment description that preceeds the class. </purpose><enum name="test_enum"><enumvalue name="test_enum_val1"><purpose>Enum value TVal1 (not the &lt; to link to the same line). </purpose></enumvalue><enumvalue name="test_enum_val2"><purpose>Enum value TVal2. </purpose></enumvalue><enumvalue name="test_enum_val3"><description><para>Enum value TVal3. (using C style comment markers). </para></description></enumvalue><purpose>An enum. </purpose><description><para>More detailed enum description. needing more than one line so using C style comment markers. </para></description></enum><data-member name="mypublic_var"><type>int</
type><purpose>A public variable. </purpose><description><para>Details about the variable. My public class variable. </para></description></data-member><method-group name="public member functions"><method name="test_me" cv=""><type>int</type><parameter name="a"><paramtype>int</paramtype><description><para>an integer argument. </para></description></parameter><parameter name="s"><paramtype>const char *</paramtype><description><para>a constant character pointer. </para></description></parameter><purpose>A normal member function taking two arguments and returning an integer value. </purpose><description><para>
+
+<para>Test(), ~Test(), testMeToo() and publicVar() </para>
+</para></description><returns><para>The test result. </para></returns></method><method name="test_me_too" cv=""><type>void</type><parameter name="c1"><paramtype>char</paramtype><description><para>the first argument. </para></description></parameter><parameter name="c2"><paramtype>char</paramtype><description><para>the second argument. </para></description></parameter><description><para>A pure virtual member with descriptions of parameters. And a 'see also' reference to another version of the function.</para><para><para>test_me() </para>
+
+</para></description></method></method-group><constructor><purpose>A constructor. </purpose><description><para>A more elaborate description of the constructor. <para>This constructor does nothing much. </para>
+</para></description></constructor><destructor><purpose>A destructor. </purpose><description><para>A more elaborate description of the destructor. <para>This destructor may explode in your face! </para>
+</para></description></destructor></class><function name="donowt"><type>int</type><parameter name="i"><paramtype>int</paramtype><description><para>is an argument that is ignored completely.</para></description></parameter><description><para>Non-member free function that does nowt useful at all.</para><para>
+
+
+
+</para></description><requires><para>No preconditions. </para></requires><postconditions><para>No side effects.</para></postconditions><returns><para>-1 always </para></returns></function></namespace></namespace><macro name="BOOST_MYLIBRARY_HPP"/></header></library-reference>