From b338a9dc265d7bc46a2528ffc45f7bf6fba96620 Mon Sep 17 00:00:00 2001
From: Robin Haberkorn <robin.haberkorn@googlemail.com>
Date: Sat, 25 Mar 2017 19:40:02 +0100
Subject: some minor Doxygen documentation improvements

 * avoid warnings
 * make sure Doxygen finds RBEntryOwnString
 * it would be nice to strip the top level `SciTECO` namespace
   but this is not supported without some macro magic that
   ommit the namespace declaration when processing with
   Doxygen.
---
 doc/Doxyfile.in | 2 +-
 src/eol.cpp     | 2 +-
 src/goto.h      | 2 +-
 src/help.h      | 2 +-
 src/sciteco.h   | 3 ++-
 5 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 3fc593e..c348346 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -152,7 +152,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = "@abs_top_srcdir@"
+STRIP_FROM_PATH        = "@abs_top_srcdir@/src"
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
diff --git a/src/eol.cpp b/src/eol.cpp
index de503e5..2dea3ef 100644
--- a/src/eol.cpp
+++ b/src/eol.cpp
@@ -248,7 +248,7 @@ EOLReaderMem::convert_all(gsize *out_len)
  * well-formed with regard to EOL sequences.
  *
  * @param buffer The buffer to convert.
- * @parem buffer_len The length of the data in buffer.
+ * @param buffer_len The length of the data in buffer.
  * @return The number of bytes consumed/converted from buffer.
  */
 gsize
diff --git a/src/goto.h b/src/goto.h
index 78a9579..c45ac27 100644
--- a/src/goto.h
+++ b/src/goto.h
@@ -56,7 +56,7 @@ class GotoTable : private RBTreeString, public Object {
 		}
 	};
 
-	class Label : public RBEntryOwnString {
+	class Label : public RBTreeString::RBEntryOwnString {
 	public:
 		gint pc;
 
diff --git a/src/help.h b/src/help.h
index 73eaa42..6287f4d 100644
--- a/src/help.h
+++ b/src/help.h
@@ -33,7 +33,7 @@ namespace SciTECO {
 
 class HelpIndex : private RBTreeStringCase, public Object {
 public:
-	class Topic : public RBEntryOwnString {
+	class Topic : public RBTreeStringCase::RBEntryOwnString {
 	public:
 		gchar	*filename;
 		tecoInt	pos;
diff --git a/src/sciteco.h b/src/sciteco.h
index b856210..664b69d 100644
--- a/src/sciteco.h
+++ b/src/sciteco.h
@@ -69,7 +69,8 @@ extern sig_atomic_t sigint_occurred;
 #define CTL_KEY(C)	((C) & ~0x40)
 /**
  * Control character of the escape key.
- * Equivalent to CTL_KEY('[') or '\e'.
+ * Equivalent to CTL_KEY('[') or '\\e',
+ * but more portable.
  */
 #define CTL_KEY_ESC	27
 /**
-- 
cgit v1.2.3