Merge pull request #2228 from afh/api-documentation

Fix generation of API documentation and prepare for publishing on ledger-cli.org

6 files changed, 63 insertions, 4 deletions

diff --git a/src/gpgme.h b/src/gpgme.h
index 00824132..1de1e197 100644
--- a/src/gpgme.h
+++ b/src/gpgme.h
@@ -29,6 +29,18 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ * @addtogroup extra
+ */
+
+/**
+ * @file   gpgme.h
+ * @author Michael Raitza
+ *
+ * @ingroup extra
+ *
+ * @brief A utility class for reading encrypted journal data
+ */
 #pragma once
 
 #include <system.hh>
@@ -123,4 +135,5 @@ namespace ledger {
        longer match with a standard ifstream. */
     static std::istream* open_stream(const path& filename);
   };
-}
+
+} // namespace ledger
diff --git a/src/option.h b/src/option.h
index 65aa653e..0d6c5140 100644
--- a/src/option.h
+++ b/src/option.h
@@ -38,6 +38,8 @@
  * @author John Wiegley
  *
  * @ingroup expr
+ *
+ * @brief Basic type and macros for handling command-line options
  */
 #ifndef INCLUDED_OPTION_H
 #define INCLUDED_OPTION_H
diff --git a/src/ptree.h b/src/ptree.h
index aa5670d7..1ffbe3dd 100644
--- a/src/ptree.h
+++ b/src/ptree.h
@@ -39,9 +39,6 @@
  *
  * @ingroup report
  *
- * @brief Brief
- *
- * Long.
  */
 #ifndef INCLUDED_PTREE_H
 #define INCLUDED_PTREE_H
diff --git a/src/pyinterp.h b/src/pyinterp.h
index c19adfc2..e9eb2312 100644
--- a/src/pyinterp.h
+++ b/src/pyinterp.h
@@ -29,6 +29,19 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ * @defgroup python Python API
+ */
+
+/**
+ * @file   pyinterp.h
+ * @author John Wiegley
+ *
+ * @ingroup python
+ *
+ * @brief Basic type for Python API.
+ */
+
 #ifndef INCLUDED_PYINTERP_H
 #define INCLUDED_PYINTERP_H
 
diff --git a/src/pyutils.h b/src/pyutils.h
index df4903cf..f7c04910 100644
--- a/src/pyutils.h
+++ b/src/pyutils.h
@@ -29,6 +29,15 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ * @file   pyutils.h
+ * @author John Wiegley
+ *
+ * @ingroup python
+ *
+ * @brief Basic utilities for Python API.
+ */
+
 #ifndef INCLUDED_PYUTILS_H
 #define INCLUDED_PYUTILS_H
 
diff --git a/src/strptime.h b/src/strptime.h
index 8c4d9de3..cccae1c4 100644
--- a/src/strptime.h
+++ b/src/strptime.h
@@ -1,3 +1,28 @@
+// Copyright 2009 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @addtogroup util
+ */
+
+/**
+ * @file   strptime.h
+ *
+ * @ingroup util
+ *
+ * @brief Implements strptime under Windows
+ */
 #ifndef INCLUDED_STRPTIME_H
 #define INCLUDED_STRPTIME_H