aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Doxyfile4
-rw-r--r--tecbuf.c10
-rw-r--r--teccmd.c10
-rw-r--r--tecdebug.c10
-rw-r--r--tecdisp.c10
-rw-r--r--tecexec.c10
-rw-r--r--tecmem.c10
-rw-r--r--teco.c14
-rw-r--r--teco.h14
-rw-r--r--tecparse.c10
-rw-r--r--tecparse.h42
-rw-r--r--tecstate.c10
-rw-r--r--tecterm.c12
-rw-r--r--tecundo.c10
-rw-r--r--tecvms.h11
15 files changed, 107 insertions, 80 deletions
diff --git a/Doxyfile b/Doxyfile
index f20ab0e..af9218b 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -297,7 +297,7 @@ SYMBOL_CACHE_SIZE = 0
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-EXTRACT_ALL = YES
+EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
@@ -1253,7 +1253,7 @@ PERLMOD_MAKEVAR_PREFIX =
# evaluate all C-preprocessor directives found in the sources and include
# files.
-ENABLE_PREPROCESSING = NO
+ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
diff --git a/tecbuf.c b/tecbuf.c
index e7c5ae4..e2e58de 100644
--- a/tecbuf.c
+++ b/tecbuf.c
@@ -9,10 +9,12 @@ struct buff_header *buff_create( char *name, char internal_flag );
* $Locker: $
*/
-/* tecbuf.c
- * Subroutines to handle the edit buffers
- *
- *
+/**
+ * \file tecbuf.c
+ * \brief Subroutines to handle the edit buffers
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/teccmd.c b/teccmd.c
index addd0f3..587a4d7 100644
--- a/teccmd.c
+++ b/teccmd.c
@@ -7,10 +7,12 @@ char *teccmd_c_version = "teccmd.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* teccmd.c
- * Subroutines which implement (usually large) TECO commands
- *
- *
+/**
+ * \file teccmd.c
+ * \brief Subroutines which implement (usually large) TECO commands
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecdebug.c b/tecdebug.c
index 717366b..710e0d2 100644
--- a/tecdebug.c
+++ b/tecdebug.c
@@ -7,10 +7,12 @@ char *tecdebug_c_version = "tecdebug.c: $Revision: 1.2 $";
* $Locker: $
*/
-/* tecdebug.c
- * Debugging routines for Teco
- *
- *
+/**
+ * \file tecdebug.c
+ * \brief Debugging routines for Teco
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecdisp.c b/tecdisp.c
index 354baf8..4d0cf3f 100644
--- a/tecdisp.c
+++ b/tecdisp.c
@@ -7,10 +7,12 @@ char *tecdisp_c_version = "tecdisp.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecdisp.c
- * Terminal Screen Display Subroutines
- *
- *
+/**
+ * \file tecdisp.c
+ * \brief Terminal Screen Display Subroutines
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecexec.c b/tecexec.c
index 89a2573..7409d0f 100644
--- a/tecexec.c
+++ b/tecexec.c
@@ -7,10 +7,12 @@ char *tecexec_c_version = "tecexec.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecexec.c
- * The SWITCH/CASE statements which implement execution stage of the parser
- *
- *
+/**
+ * \file tecexec.c
+ * \brief The SWITCH/CASE statements which implement execution stage of the parser
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecmem.c b/tecmem.c
index 92533cc..708a946 100644
--- a/tecmem.c
+++ b/tecmem.c
@@ -7,10 +7,12 @@ char *tecmem_c_version = "tecmem.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecmem.c
- * Subroutines to manage memory allocation and deallocation
- *
- *
+/**
+ * \file tecmem.c
+ * \brief Subroutines to manage memory allocation and deallocation
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/teco.c b/teco.c
index 25c78db..ef78d56 100644
--- a/teco.c
+++ b/teco.c
@@ -8,10 +8,12 @@ char *copyright = "Copyright (c) 1985-2007 Paul Cantrell";
* $Locker: $
*/
-/* teco.c
- * Main TECO entry point with most of the initialization code
- *
- *
+/**
+ * \file teco.c
+ * \brief Main TECO entry point with most of the initialization code
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
@@ -74,12 +76,12 @@ char *copyright = "Copyright (c) 1985-2007 Paul Cantrell";
int checkpoint_interval = DEFAULT_CHECKPOINT;
char *output_tty_name;
-/*
+/**
* Table of Bit Positions
*/
unsigned int IntBits[BITS_PER_INT];
-/*
+/**
* Table of Spaces for tab expansion
*/
char tab_expand[MAX_TAB_WIDTH+1];
diff --git a/teco.h b/teco.h
index 8c081ac..cb2df2e 100644
--- a/teco.h
+++ b/teco.h
@@ -5,10 +5,12 @@
* $Locker: $
*/
-/* teco.h
- * Global TECO Definitions
- * %W% (PC) %G%
- *
+/**
+ * \file teco.h
+ * \brief Global TECO Definitions
+ */
+
+/*
* COPYRIGHT (c) 1985-2007 BY Paul Cantrell
*
* Copyright (C) <year> <name of author>
@@ -76,7 +78,7 @@
* conditional compilation based on different machines quirks can be done.
*/
-/*
+/**
* Unless defined otherwise, we assume 32 bits to an integer and 8 bits / char
*/
#ifndef BITS_PER_INT
@@ -340,7 +342,7 @@
typedef unsigned long teco_ptrint_t;
-/*
+/**
* We define unix except for the really different operating systems, like
* vms. It lets us write our own version of functions which simply do not
* exist outside of unix.
diff --git a/tecparse.c b/tecparse.c
index b1a3c16..aa10aa7 100644
--- a/tecparse.c
+++ b/tecparse.c
@@ -7,10 +7,12 @@ char *tecparse_c_version = "tecparse.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecparse.c
- * Subroutines to implement the finite state parser
- *
- *
+/**
+ * \file tecparse.c
+ * \brief Subroutines to implement the finite state parser
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecparse.h b/tecparse.h
index c99b6ab..fcccd25 100644
--- a/tecparse.h
+++ b/tecparse.h
@@ -5,10 +5,12 @@
* $Locker: $
*/
-/* tecparse.h
- * Definitions for TECO parser
- * %W% (PC) %G%
- *
+/**
+ * \file tecparse.h
+ * \brief Definitions for TECO parser
+ */
+
+/*
*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
@@ -26,7 +28,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
+/**
* This structure holds the context which must be passed forward as the
* parse progresses. We split it out of the cmd_token structure so that
* it can be easily duplicated.
@@ -49,7 +51,7 @@ struct cmd_context {
struct cmd_token *caller_token;
};
-/*
+/**
* Define the structure which we use to describe commands
*/
struct cmd_token {
@@ -86,20 +88,20 @@ struct undo_token {
#define CTOK_M_ATSIGN_SEEN (1 << 1)
#define CTOK_M_STATUS_PASSED (1 << 2)
-#define TOK_C_UNUSED 0 /* Value before it gets set */
-#define TOK_C_FIRSTTOKEN 1 /* The begining of it all */
-#define TOK_C_INPUTCHAR 2 /* An input character was recieved here */
-#define TOK_C_COPYTOKEN 3 /* A copy of a previous command token */
-#define TOK_C_ITERATION_BEGIN 4 /* Marks the begining of an iteration */
-#define TOK_C_ITERATION_END 5 /* Marks the end of an iteration */
-#define TOK_C_CONDITIONAL_END 6 /* Marks end of a conditional cmd */
-#define TOK_C_LABEL_BEGIN 7 /* Begining of a label tag !like this! */
-#define TOK_C_LABEL_END 8 /* End of a label tag */
-#define TOK_C_GOTO_BEGIN 9 /* Begining of an Omumble$ string */
-#define TOK_C_GOTO_END 10 /* End of an Omumble$ string */
-#define TOK_C_FINALTOKEN 11 /* Like FINALSTATE */
-#define TOK_C_INITIALSTATE 12 /* Used by ^W to find begining of cmds */
-#define TOK_C_CONDITIONAL_ELSE 13/* Marks begining of an ELSE clause */
+#define TOK_C_UNUSED 0 /**< Value before it gets set */
+#define TOK_C_FIRSTTOKEN 1 /**< The begining of it all */
+#define TOK_C_INPUTCHAR 2 /**< An input character was recieved here */
+#define TOK_C_COPYTOKEN 3 /**< A copy of a previous command token */
+#define TOK_C_ITERATION_BEGIN 4 /**< Marks the begining of an iteration */
+#define TOK_C_ITERATION_END 5 /**< Marks the end of an iteration */
+#define TOK_C_CONDITIONAL_END 6 /**< Marks end of a conditional cmd */
+#define TOK_C_LABEL_BEGIN 7 /**< Begining of a label tag <tt>!like this!</tt>*/
+#define TOK_C_LABEL_END 8 /**< End of a label tag */
+#define TOK_C_GOTO_BEGIN 9 /**< Begining of an \c Omumble\$ string */
+#define TOK_C_GOTO_END 10 /**< End of an \c Omumble\$ string */
+#define TOK_C_FINALTOKEN 11 /**< Like \c FINALSTATE */
+#define TOK_C_INITIALSTATE 12 /**< Used by \c ^W to find begining of cmds */
+#define TOK_C_CONDITIONAL_ELSE 13 /**< Marks begining of an ELSE clause */
#define STATE_C_INITIALSTATE 0
#define STATE_C_MAINCOMMANDS 1
diff --git a/tecstate.c b/tecstate.c
index 4af14f4..d93fa52 100644
--- a/tecstate.c
+++ b/tecstate.c
@@ -7,10 +7,12 @@ char *tecstate_c_version = "tecstate.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecstate.c
- * Main SWITCH/CASE statements to implement the parser syntax stage
- *
- *
+/**
+ * \file tecstate.c
+ * \brief Main SWITCH/CASE statements to implement the parser syntax stage
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecterm.c b/tecterm.c
index db7b98c..8f196ce 100644
--- a/tecterm.c
+++ b/tecterm.c
@@ -7,10 +7,12 @@ char *tecterm_c_version = "tecterm.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecterm.c
- * Terminal Escape Sequence Subroutines (termcap/terminfo et all)
- *
- *
+/**
+ * \file tecterm.c
+ * \brief Terminal Escape Sequence Subroutines (termcap/terminfo et all)
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
@@ -98,7 +100,7 @@ char *tecterm_c_version = "tecterm.c: $Revision: 1.3 $";
extern int tty_input_chan;
extern int tty_output_chan;
-/*
+/**
* The following array gives the number of tens of milliseconds per
* character for each speed as returned by gtty. Thus since 300
* baud returns a 7, there are 33.3 milliseconds per char at 300 baud.
diff --git a/tecundo.c b/tecundo.c
index c084650..c841ec5 100644
--- a/tecundo.c
+++ b/tecundo.c
@@ -7,10 +7,12 @@ char *tecundo_c_version = "tecundo.c: $Revision: 1.3 $";
* $Locker: $
*/
-/* tecundo.c
- * Subroutines to implement the undo capabilities of the parser
- *
- *
+/**
+ * \file tecundo.c
+ * \brief Subroutines to implement the undo capabilities of the parser
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify
diff --git a/tecvms.h b/tecvms.h
index 68981f6..fe16a6e 100644
--- a/tecvms.h
+++ b/tecvms.h
@@ -5,11 +5,12 @@
* $Locker: $
*/
-/* tecvms.h
- * Include file for VMS build
- * %W% (PC) %G%
- *
- *
+/**
+ * \file tecvms.h
+ * \brief Include file for VMS build
+ */
+
+/*
* Copyright (C) 1985-2007 BY Paul Cantrell
*
* This program is free software: you can redistribute it and/or modify