Commit a81ce474 authored by Dimitri van Heesch's avatar Dimitri van Heesch
Browse files

+ The graphical class hierarchy was not properly generated when 

  template classes were used.
+ Template specialization could not be documented using the
  \class command. This is now fixed. Example:
  /*!
   * \class T<A,int>
   * My template specialization of template T.
   */
+ Fixed a bug when parsing M$-IDL code, containing
  helpstring("bla") attributes. The attributes of a method are no longer
  shown in the documentation (the attributes of method arguments
  still visible however).
+ Improved the search algorithm that tries to connect classes with their
  base classes. It should now (hopefully) work correct in all cases
  where nested classes and/or namespaces are used.
+ Fixed a scanner problem that could cause doxygen to get
  confused after parsing struct initializers.
+ the DOTFONTPATH environment variable is now automatically set
  for Windows. This should make any "missing doxfont.ttf"
  messages disappear.
+ the extra LaTeX packages specified with EXTRA_PACKAGES can now
  also be used when generating formulas for HTML.
+ The documentation of a parameters that is part of a member definition,
  is now used in the documentation as well.
+ Fixed a HTML output bug in the class/file group-pages.
+ Links to example files generated with \link ... \endlink where not
  correct.
+ made the bullet list generation more robust. A space is now required
  after the - sign. A list can now start a paragraph.
+ the configure script now detects whether or not dot is installed.
+ The VERBATIM_HEADERS option didn't have any effect any more.
  It should now works again as advertised.
+ The IGNORE_PREFIX option can now also deal with a list of prefixes.
+ @verbatim ... @endverbatim blocks did not work.
+ new option SHOW_INCLUDE_FILES, which can be set to NO to turn of the
  list of include files that is generated for each documented file.
+ new option STRIP_CODE_COMMENTS, which can be set to NO to keep any
  special comment blocks in the generated code fragments.
parent ddbc18f5

INSTALL

+4 −4
Original line number Original line Diff line number Diff line 
DOXYGEN Version 1.1.0

DOXYGEN Version 1.1.0-20000220





CONTENTS

CONTENTS

--------

--------
@@ -15,8 +15,8 @@ INSTALLATION INSTRUCTIONS FOR UNIX: 




1.  Unpack the archive, unless you already have:

1.  Unpack the archive, unless you already have:

   

   

     gunzip doxygen-1.1.0.src.tar.gz    # uncompress the archive

     gunzip doxygen-1.1.0-20000220.src.tar.gz    # uncompress the archive

     tar xf doxygen-1.1.0.src.tar       # unpack it

     tar xf doxygen-1.1.0-20000220.src.tar       # unpack it





2.  Run the configure script:

2.  Run the configure script:
@@ -252,4 +252,4 @@ The latest version of doxygen can be obtained at 




Enjoy,

Enjoy,





Dimitri van Heesch (13 February 2000)
 
Dimitri van Heesch (20 February 2000)

README

+2 −2
Original line number Original line Diff line number Diff line 
DOXYGEN Version 1.1.0

DOXYGEN Version 1.1.0-20000220





Please read INSTALL for compilation instructions.

Please read INSTALL for compilation instructions.
@@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at 




Enjoy,

Enjoy,





Dimitri van Heesch (13 February 2000)
 
Dimitri van Heesch (20 February 2000)

VERSION

+1 −1
Original line number Original line Diff line number Diff line 
1.1.0
 
1.1.0-20000220

configure

+39 −4
Original line number Original line Diff line number Diff line
@@ -19,6 +19,7 @@ bin_dirs=`echo $PATH | sed -e "s/:/ /g"` 
f_debug=NO

f_debug=NO

f_shared=YES

f_shared=YES

f_make=NO

f_make=NO

f_dot=NO

f_perl=NO

f_perl=NO

f_plf_auto=NO

f_plf_auto=NO

f_prefix=/usr

f_prefix=/usr
@@ -51,6 +52,9 @@ while test -n "$1"; do 
    --make)

    --make)

       shift; f_make=$1

       shift; f_make=$1

       ;;

       ;;

    --dot)

       shift; f_dot=$1

       ;;

    --perl)

    --perl)

       shift; f_perl=$1

       shift; f_perl=$1

       ;;

       ;;
@@ -72,10 +76,10 @@ done 
if test "$f_help" = y; then

if test "$f_help" = y; then

  cat <<EOF

  cat <<EOF

Usage: $0 [--help] [--shared] [--static] [--release] [--debug] 

Usage: $0 [--help] [--shared] [--static] [--release] [--debug] 

          [--perl name] [--make name] [--platform target] [--prefix dir]

          [--perl name] [--make name] [--dot name] [--platform target] 

          [--install name] [--english-only]

          [--prefix dir] [--install name] [--english-only]





Options:ll 

Options: 





  --help                Print this help

  --help                Print this help
@@ -91,6 +95,10 @@ Options:ll 
  --make name           Use \`name' as the name of the GNU make tool

  --make name           Use \`name' as the name of the GNU make tool

		        [default: autodetect]

		        [default: autodetect]





  --dot name            Use \`name' as the name of the dot tool that

                        is part of the Graphviz package.

                        [default: autodetect]



  --platform target     Do not detect platform but use \`target' instead.

  --platform target     Do not detect platform but use \`target' instead.

                        See PLATFORMS for a list of possibilities

                        See PLATFORMS for a list of possibilities
@@ -241,6 +249,27 @@ if test "$f_make" = NO; then 
fi

fi

echo "using $f_make"

echo "using $f_make"





# - check for dot ------------------------------------------------------------



echo -n "  Checking for dot... "

if test "$f_dot" = NO; then

  dot_dirs="$bin_dirs"

  dot_prog=NO

  for j in $dot_dirs; do

    if test -x "$j/dot"; then

      dot_prog="$j/dot"

      break 2

    fi

  done

  f_dot="$dot_prog" 

fi



if test "$f_dot" = NO; then

  echo "not found!";

else

  echo "using $f_dot"

fi



# - check for perl ------------------------------------------------------------

# - check for perl ------------------------------------------------------------





echo -n "  Checking for perl... "

echo -n "  Checking for perl... "
@@ -294,6 +323,12 @@ DOXYDOCS = .. 
export TMAKEPATH

export TMAKEPATH

EOF

EOF





if test "$f_dot" != NO; then

  cat >> .makeconfig <<EOF

HAVE_DOT  = $f_dot

EOF

fi



touch .tmakeconfig

touch .tmakeconfig

if test "$f_shared" = NO; then

if test "$f_shared" = NO; then

  cat >> .tmakeconfig <<EOF

  cat >> .tmakeconfig <<EOF

doc/config.doc

+21 −4
Original line number Original line Diff line number Diff line
@@ -120,7 +120,9 @@ followed by the descriptions of the tags grouped by category. 
<li> \refitem cfg_repeat_brief REPEAT_BRIEF

<li> \refitem cfg_repeat_brief REPEAT_BRIEF

<li> \refitem cfg_search_includes SEARCH_INCLUDES

<li> \refitem cfg_search_includes SEARCH_INCLUDES

<li> \refitem cfg_searchengine SEARCHENGINE

<li> \refitem cfg_searchengine SEARCHENGINE

<li> \refitem cfg_show_include_files SHOW_INCLUDE_FILES

<li> \refitem cfg_source_browser SOURCE_BROWSER

<li> \refitem cfg_source_browser SOURCE_BROWSER

<li> \refitem cfg_strip_code_comments STRIP_CODE_COMMENTS

<li> \refitem cfg_strip_from_path STRIP_FROM_PATH

<li> \refitem cfg_strip_from_path STRIP_FROM_PATH

<li> \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS

<li> \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS

<li> \refitem cfg_rtf_output RTF_OUTPUT

<li> \refitem cfg_rtf_output RTF_OUTPUT
@@ -292,6 +294,13 @@ followed by the descriptions of the tags grouped by category. 
 Setting the \c INLINE_SOURCES tag to \c YES will include the body

 Setting the \c INLINE_SOURCES tag to \c YES will include the body

 of functions, classes and enums directly into the documentation.

 of functions, classes and enums directly into the documentation.





\anchor cfg_strip_code_comments

<dt>\c STRIP_CODE_COMMENTS <dd>

 \addindex STRIP_CODE_COMMENTS

 Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct

 doxygen to hide any special comment blocks from generated source code

 fragments. Normal C and C++ comments will always remain visible.



\anchor cfg_case_sense_names

\anchor cfg_case_sense_names

<dt>\c CASE_SENSE_NAMES <dd>

<dt>\c CASE_SENSE_NAMES <dd>

 \addindex CASE_SENSE_NAMES

 \addindex CASE_SENSE_NAMES
@@ -309,6 +318,13 @@ followed by the descriptions of the tags grouped by category. 
  which an include is specified. Set to NO to disable this.

  which an include is specified. Set to NO to disable this.

  \sa Section \ref cmdclass "\\class".

  \sa Section \ref cmdclass "\\class".





\anchor cfg_show_include_files

<dt>\c SHOW_INCLUDE_FILES <dd>

 \addindex SHOW_INCLUDE_FILES

 If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen

 will put list of the files that are included by a file in the documentation 

 of that file.



\anchor cfg_javadoc_autobrief

\anchor cfg_javadoc_autobrief

<dt>\c JAVADOC_AUTOBRIEF <dd>

<dt>\c JAVADOC_AUTOBRIEF <dd>

 \addindex JAVADOC_AUTOBRIEF

 \addindex JAVADOC_AUTOBRIEF
@@ -559,10 +575,11 @@ used to specify the number of columns in which this list will be split (can be a 




\anchor cfg_ignore_prefix

\anchor cfg_ignore_prefix

<dt>\c IGNORE_PREFIX <dd>

<dt>\c IGNORE_PREFIX <dd>

In case all classes in a project start with a common prefix, all

In case all classes in a project start with a common prefix, all classes will 

classes will be put under the same header in the alphabetical index.

be put under the same header in the alphabetical index.

The \c IGNORE_PREFIX tag can be use to specify a prefix that should be ignored

The \c IGNORE_PREFIX tag can be used to specify a prefix 

while generating the index headers.

(or a list of prefixes) that should be ignored while generating the index 

headers.





</dl>

</dl>