Bump version to 2.5.

Add --heading option to place contact before table-of-contents and intro.

Tweak the mxmldoc test suite.

Use " instead of ' for attribute values.

Quote titles, etc. as needed.

Move TOC and HTML header generation to separate functions in preparation for
frame support.
This commit is contained in:
Michael R Sweet 2008-01-26 20:50:28 +00:00
parent 1e2bbbc851
commit ee8df0fe52
11 changed files with 1603 additions and 1521 deletions

View File

@ -1,7 +1,7 @@
CHANGES - 2008-01-12
CHANGES - 2008-01-26
--------------------
CHANGES IN Mini-XML 2.4.1
CHANGES IN Mini-XML 2.5
- The man pages and man page output from mxmldoc did
not use "\-" for dashes (STR #68)

View File

@ -325,7 +325,7 @@ testmxml.o: mxml.h
mxml.xml: mxmldoc-static mxml.h $(PUBLIBOBJS:.o=.c)
$(RM) mxml.xml
./mxmldoc-static --intro doc/reference.intro mxml.xml mxml.h $(PUBLIBOBJS:.o=.c) >doc/reference.html
./mxmldoc-static --heading doc/reference.heading mxml.xml mxml.h $(PUBLIBOBJS:.o=.c) >doc/reference.html
valgrind: mxmldoc-static
$(RM) valgrind.xml

8
TODO
View File

@ -10,10 +10,10 @@ TODO - 2008-01-25
- Binary XML support???
- mxmldoc
DONE -- --css filename option
-- First paragraph is description
-- Remaining is "Discussion"
-- Add element for write_description().
-- Add write_function() with base heading level, add for methods.
DONE -- First paragraph is description
DONE -- Remaining is "Discussion"
DONE -- Add element for write_description().
DONE -- Add write_function() with base heading level, add for methods.
-- --framed filename option (filename-toc.html,
filename-body.html, filename.html)
-- Add link/constant markup a la Doxygen for description text.

2
configure vendored
View File

@ -1717,7 +1717,7 @@ ac_compiler_gnu=$ac_cv_c_compiler_gnu
ac_config_headers="$ac_config_headers config.h"
VERSION=2.4
VERSION=2.5
cat >>confdefs.h <<_ACEOF
#define MXML_VERSION "Mini-XML v$VERSION"

View File

@ -3,7 +3,7 @@ dnl "$Id$"
dnl
dnl Configuration script for Mini-XML, a small XML-like file parsing library.
dnl
dnl Copyright 2003-2007 by Michael Sweet.
dnl Copyright 2003-2008 by Michael Sweet.
dnl
dnl This program is free software; you can redistribute it and/or
dnl modify it under the terms of the GNU Library General Public
@ -23,7 +23,7 @@ dnl Set the name of the config header file...
AC_CONFIG_HEADER(config.h)
dnl Version number...
VERSION=2.4
VERSION=2.5
AC_SUBST(VERSION)
AC_DEFINE_UNQUOTED(MXML_VERSION, "Mini-XML v$VERSION")

File diff suppressed because it is too large Load Diff

1638
mxmldoc.c

File diff suppressed because it is too large Load Diff

View File

@ -1,14 +1,44 @@
#!/bin/sh
(cd ..; make mxmldoc-static)
if test $# -gt 0; then
files=$*
else
files=""
mode=""
while test $# -gt 0; do
arg="$1"
shift
case "$arg" in
-g) mode="gdb" ;;
-v) mode="valgrind" ;;
*.h | *.c | *.cxx) files="$files $arg" ;;
*)
echo "Usage: ./dotest.sh [-g] [-v] [files]"
exit 1
;;
esac
done
if test "$files" = ""; then
files=*.cxx
fi
rm -f test.xml
#../mxmldoc-static test.xml $files >test.html 2>test.log
valgrind --log-fd=3 --leak-check=yes ../mxmldoc-static test.xml \
$files >test.html 2>test.log 3>test.valgrind
case "$mode" in
gdb)
echo "run test.xml $files >test.html 2>test.log" >.gdbcmds
gdb -x .gdbcmds ../mxmldoc-static
;;
valgrind)
valgrind --log-fd=3 --leak-check=yes \
../mxmldoc-static test.xml $files \
>test.html 2>test.log 3>test.valgrind
;;
*)
../mxmldoc-static test.xml $files >test.html 2>test.log
;;
esac

View File

@ -3,5 +3,6 @@ typedef enum foo_enum_e /* Sample enumeration type */
FOO_ONE, /* One fish */
FOO_TWO, /* Two fish */
FOO_RED, /* Red fish */
FOO_BLUE /* Blue fish */
FOO_BLUE, /* Blue fish */
FOO_PRIVATE /* Private fish @private@ */
} foo_enum_t;

View File

@ -36,7 +36,8 @@ typedef struct foo_s /* Foo structure */
} foo_t;
// 'foo_s::foo_s()' - Create a foo_s structure.
foo_s::foo_s(float f, int b)
foo_s::foo_s(float f, // I - Value of foo
int b) // I - Value of bar
{
foo = f;
bar = b;