aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2017-03-25 19:40:02 +0100
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2017-03-25 19:40:02 +0100
commitb338a9dc265d7bc46a2528ffc45f7bf6fba96620 (patch)
treecc19ab8533d51e3a9cceb707ee4065a4a0ca86ff /src
parent7a9328b4d66d746f815d190751a2e3ad75e397a0 (diff)
downloadsciteco-b338a9dc265d7bc46a2528ffc45f7bf6fba96620.tar.gz
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.
Diffstat (limited to 'src')
-rw-r--r--src/eol.cpp2
-rw-r--r--src/goto.h2
-rw-r--r--src/help.h2
-rw-r--r--src/sciteco.h3
4 files changed, 5 insertions, 4 deletions
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
/**