doxygen-develop — List for discussing new features, submitting patches, etc.

[Doxygen-develop] =?gb2312?B?tPC4tDogW0RveHlnZW4tZGV2ZWxvcF0gQ2hpbmVzZSB0cmFuc2xh?= =?gb2312?B?dGlvbiB1cGRhdGU=?=

[Wei L. <li...@as...>]

I have updated Chinese translation for doxygen.=20
When running doxygen/doc/translator.pl, no problem found.


-----=D4=AD=CA=BC=D3=CA=BC=FE-----
=B7=A2=BC=FE=C8=CB: Prikryl,Petr [mailto:PRI...@sk...]
=B7=A2=CB=CD=CA=B1=BC=E4: 2001=C4=EA10=D4=C217=C8=D5 22:40
=CA=D5=BC=FE=C8=CB: Wei Liu
=B3=AD=CB=CD: Dimitri van Heesch
=D6=F7=CC=E2: RE: [Doxygen-develop] Chinese translation update


Hi Wei,

It seems to compile fine, so there should be no problem
when Dimitry adds this to the distribution.  I would like to=20
add only some minor remarks.=20

There is no need to #include "translator_adapter.h" now (nor
any other header file).

When running doxygen/doc/translator.pl, you will obtain
translator_report.txt.  (I am going to send the update soon
to produce more accurate report in your case.  Then...) =20
You can see your translator placed among the up-to-date=20
translators like this:

  TranslatorChinese     -- see details below in the report

The "-- see details below in the report" means that there
are some additional remarks below in the report.
In your case, the report contains also:

TranslatorChinese (Translator)
-----------------

Obsolete methods (should be removed):

  QCString latexBabelPackage()
  QCString trAuthor()
  QCString trAuthors()
  QCString trFiles()
  QCString trVerbatimText(const char *f)

These methods are never called.  You should remove them.
See details in the "Internalization" part of the doxygen documentation
(langhowto.html).

Thanks for updating your translator part,
  Petr

--=20
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

> -----Original Message-----
> From:	Wei Liu [SMTP:li...@as...]
> Sent:	Wednesday, October 17, 2001 5:25 AM
> To:	Wei Liu;=20
> Subject:	[Doxygen-develop] Chinese translation update
>=20
> Hi,
>=20
> I have finally updated Chinese translation for doxygen-1.2.11.=20
> Here is two patch file included as an attachement.
>=20
> Charlie Liu
>=20
>  << File: doxygen-chinese.patch.tar.gz >>=20

[Doxygen-develop] Slovak language update

[Stanislav K. <sk...@po...>]

I have updated slovak translator from version 1.2.11 to 1.2.13. A diffed=20
patch file is included to do the job.

Stanislav Kudlac
=0A____________________________________=0Ahttp://www.pobox.sk/ - urcujeme t=
rendy=0A=0A

Re: [Doxygen-develop] caption support for tables

[Dimitri v. H. <di...@st...>]

On Mon, Dec 24, 2001 at 05:19:50PM +0100, Pascal Flammant wrote:
> Hello,
> 
> attached you can find a patch (diffed against 20011209 cvs version) that
> adds caption support for the <table></table> environment to doxygen.
> i.e. the patch makes doxygen understand <caption> and </caption> tags.
> It supports html and latex output.

Thanks, your patch (with some small modifications) will go into 1.2.13.1.

Regards,
  Dimitri

[Doxygen-develop] caption support for tables

[Pascal F. <pfl...@ee...>]

Hello,

attached you can find a patch (diffed against 20011209 cvs version) that
adds caption support for the <table></table> environment to doxygen.
i.e. the patch makes doxygen understand <caption> and </caption> tags.
It supports html and latex output.

greetings,
pascal

[Doxygen-develop] Re: Doxygen support for the programming language MuPAD

[Nicolas M. T. <nt...@us...>]

         Dear doxygen developers,

> I guess I would basicaly need to write a parser description in
> src/mupad.ll starting with the java.ll example.

Oops, sorry, I made a mix with doc++ which I am also investigating for
the same purpose. For doxygen, the description of the syntax of the
different languages seems pretty much hardcoded in the sources, so I
really don't know where to start.

Thanks in advance,
						Nicolas
-- 
Nicolas M. Thiéry "Isil" <nt...@us...>
http://www.mines.edu/~nthiery/
LaPCS, Université Claude Bernard Lyon I, Bâtiment recherche [B]
50, avenue Tony-Garnier, Domaine de Gerland, 69366 Lyon Cedex 07 
tel: +33 4 37 28 74 51 fax: +33 4 72 43 10 54

[Doxygen-develop] Doxygen support for the programming language MuPAD

[Nicolas M. T. <nt...@us...>]

        Dear doxygen developers,

I am currently looking for a tool for documenting a library written in
the MuPAD language (this is a computer algebra system, similar to
maple). Doxygen seems to do pretty much all I need!

So here is my question: how difficult is it to add support in doxygen
for new programming languages ?

I guess I would basicaly need to write a parser description in
src/mupad.ll starting with the java.ll example. Any comments, details,
descriptions of pitfall, or even better a basic template for such a
parser would be warmly welcome. See below for a rather complete
example of MuPAD code with the corresponding C++ code.

Thanks in advance!

Best regards,
                                                Nicolas

References:
 - mupad-combinat.sourceforge.net
 - www.mupad.de

---------------------------------------------------------------------------
/**
    A domain for partitions
**/
domain combinat::partitions

    // this declares factorial as a public method
    interface := { hold(factorial) };

    /// the factorial function
    factorial :=
    proc(n: DOM_INT) : DOM_INT
    begin
        if n=0 then
            1
        else
            n*dom::factorial(n-1);
        end_if;
    end_proc;

    ...

begin
end_domain

---------------------------------------------------------------------------
/**
    A class for partitions
**/
class combinat::partitions {

  public:

    /// the factorial function
    int
    factorial(int n) {
        if (n==0) {
            return(1);
        else {
            return(factorial(n-1));
        }
    }

  private:
    ...
}
------------------------------------------------------------------------------

-- 
Nicolas M. Thiéry "Isil" <nt...@us...>
http://www.mines.edu/~nthiery/
LaPCS, Université Claude Bernard Lyon I, Bâtiment recherche [B]
50, avenue Tony-Garnier, Domaine de Gerland, 69366 Lyon Cedex 07 
tel: +33 4 37 28 74 51 fax: +33 4 72 43 10 54

Re: [Doxygen-develop] First element of in-class enum partially ignored by doxygen

[Biswapesh C. <bis...@tc...>]

You probably need the '<' sign after '///'

- Biswa.

On Wed, 2001-12-05 at 13:58, Gunnar Henne wrote:
> Hello,
> 
> I hope this list is the right one for my bugreport.
> 
> I want do document the elements of named enums which are declared inside
> a class declaration.
> In the overview I see all members, but in the lower long-description,
> the first element if the enum ist missing.
> 
> Attached is a short sample code to demonstrate the problem.
> 
> Regards
> 
> Gunnar Henne

[Doxygen-develop] First element of in-class enum partially ignored by doxygen

[Gunnar H. <he...@ot...>]

Hello,

I hope this list is the right one for my bugreport.

I want do document the elements of named enums which are declared inside
a class declaration.
In the overview I see all members, but in the lower long-description,
the first element if the enum ist missing.

Attached is a short sample code to demonstrate the problem.

Regards

Gunnar Henne

[Doxygen-develop] Doxygen.pm perl script

[<ric...@gr...>]

I wrote the following perl script to aid in writing other perl scripts
to control doxygen.  I found it very handy.  Any feedback would be
appreciated.

### Copyright (c) 2001 Richard Y. Kim
###
### This is free software; you can redistribute it and/or modify
### it under the terms of the GNU General Public License as published by
### the Free Software Foundation; either version 2, or (at your option)
### any later version.
### See <http://www.gnu.org/licenses/gpl.html> for details.
###
### Author: Richard Y. Kim, <ric...@gr...>
### Maintainer: Richard Y. Kim, <ric...@gr...>
### Created: Fri Nov 30 12:13:44 2001
### Version: 0.1
### 
### This utility provides a simple framework for creating and modifying
### doxygen <http://www.doxygen.org> configuration files and running doxygen.
### See the end of this file for details.
###
package Doxygen;

###****************************************************************************
###@ Configuration File
###****************************************************************************

my $this_prog  = $0;

###============================================================================
###@@ Default Hash Table
###============================================================================

# This is the default value of all objects created via Doxygen->new method.
my $doxygen_defaults =
{
  'ALIASES'               => '',
  'ALLEXTERNALS'          => 'YES',
  'ALPHABETICAL_INDEX'    => 'YES',
  'ALWAYS_DETAILED_SEC'   => 'NO',
  'BINARY_TOC'            => 'NO',
  'BIN_ABSPATH'           => '',
  'BRIEF_MEMBER_DESC'     => 'YES',
  'CASE_SENSE_NAMES'      => 'YES',
  'CGI_NAME'              => 'dsearch',
  'CGI_URL'               => 'http://localhost/cgi-bin',
  'CLASS_DIAGRAMS'        => 'YES',
  'CLASS_GRAPH'           => 'YES',
  'COLLABORATION_GRAPH'   => 'YES',
  'COLS_IN_ALPHA_INDEX'   => '5',
  'COMPACT_LATEX'         => 'NO',
  'COMPACT_RTF'           => 'NO',
  'DISABLE_INDEX'         => 'NO',
  'DISTRIBUTE_GROUP_DOC'  => 'NO',
  'DOTFILE_DIRS'          => '',
  'DOC_ABSPATH'           => '',
  'DOC_URL'               => '',
  'DOTFILE_DIRS'          => '',
  'DOT_CLEANUP'           => 'YES',
  'DOT_PATH'              => '',
  'ENABLED_SECTIONS'      => '',
  'ENABLE_PREPROCESSING'  => 'YES',
  'ENUM_VALUES_PER_LINE'  => '4',
  'EXAMPLE_PATH'          => '',
  'EXAMPLE_PATTERNS'      => '',
  'EXAMPLE_RECURSIVE'     => '',
  'EXCLUDE'               => '',
  'EXCLUDE_PATTERNS'      => '',
  'EXPAND_AS_DEFINED'     => '',
  'EXPAND_ONLY_PREDEF'    => 'NO',
  'EXTRACT_ALL'           => 'YES',
  'EXTRACT_PRIVATE'       => 'YES',
  'EXTRACT_STATIC'        => 'YES',
  'EXTRA_PACKAGES'        => '',
  'EXT_DOC_PATHS'         => '',
  'FILE_PATTERNS'         => '*.h *.hpp *.c *.cpp',
  'FILTER_SOURCE_FILES'   => 'NO',
  'FULL_PATH_NAMES'       => 'NO',
  'GENERATE_BUGLIST'      => 'NO',
  'GENERATE_CHI'          => 'NO',
  'GENERATE_HTML'         => 'YES',
  'GENERATE_HTMLHELP'     => 'NO',
  'GENERATE_LATEX'        => 'NO',
  'GENERATE_LEGEND'       => 'YES',
  'GENERATE_MAN'          => 'NO',
  'GENERATE_RTF'          => 'NO',
  'GENERATE_TAGFILE'      => '',
  'GENERATE_TESTLIST'     => 'NO',
  'GENERATE_TODOLIST'     => 'NO',
  'GENERATE_TREEVIEW'     => 'NO',
  'GENERATE_XML'          => 'NO',
  'GRAPHICAL_HIERARCHY'   => 'YES',
  'HAVE_DOT'              => 'YES',
  'HIDE_SCOPE_NAMES'      => 'NO',
  'HIDE_UNDOC_CLASSES'    => 'NO',
  'HIDE_UNDOC_MEMBERS'    => 'NO',
  'HIDE_UNDOC_RELATIONS'  => 'NO',
  'HTML_ALIGN_MEMBERS'    => 'YES',
  'HTML_FOOTER'           => '',
  'HTML_HEADER'           => '',
  'HTML_OUTPUT'           => 'html',
  'HTML_STYLESHEET'       => '',
  'IGNORE_PREFIX'         => '',
  'IMAGE_PATH'            => '',
  'INCLUDED_BY_GRAPH'     => 'YES',
  'INCLUDE_FILE_PATTERNS' => '*.h *.hpp',
  'INCLUDE_GRAPH'         => 'YES',
  'INCLUDE_PATH'          => '',
  'INHERIT_DOCS'          => 'YES',
  'INLINE_INFO'           => 'YES',
  'INLINE_SOURCES'        => 'YES',
  'INPUT'                 => '',
  'INPUT_FILTER'          => '',
  'INTERNAL_DOCS'         => 'NO',
  'JAVADOC_AUTOBRIEF'     => 'NO',
  'LATEX_BATCHMODE'       => 'NO',
  'LATEX_HEADER'          => '',
  'LATEX_OUTPUT'          => 'latex',
  'MACRO_EXPANSION'       => 'YES',
  'MAN_EXTENSION'         => '',
  'MAN_LINKS'             => '',
  'MAN_OUTPUT'            => 'man',
  'MAX_DOT_GRAPH_HEIGHT'  => '1024',
  'MAX_DOT_GRAPH_WIDTH'   => '1024',
  'MAX_INITIALIZER_LINES' => '30',
  'OPTIMIZE_OUTPUT_FOR_C' => 'NO',
  'OUTPUT_DIRECTORY'      => '',
  'OUTPUT_LANGUAGE'       => 'English',
  'PAPER_TYPE'            => 'a4wide',
  'PDF_HYPERLINKS'        => 'NO',
  'PERL_PATH'             => '/usr/bin/perl',
  'PREDEFINED'            => '',
  'PROJECT_NAME'          => 'Unnamed Project',
  'PROJECT_NUMBER'        => '0.0',
  'QUIET'                 => 'YES',
  'RECURSIVE'             => 'YES',
  'REFERENCED_BY_RELATION'=> '',
  'REFERENCES_RELATION'   => '',
  'REPEAT_BRIEF'          => 'YES',
  'RTF_EXTENSIONS_FILE'   => '',
  'RTF_HYPERLINKS'        => 'NO',
  'RTF_OUTPUT'            => 'rtf',
  'RTF_STYLESHEET_FILE'   => '',
  'SEARCHENGINE'          => 'NO',
  'SEARCH_INCLUDES'       => 'YES',
  'SHORT_NAMES'           => 'NO',
  'SHOW_INCLUDE_FILES'    => 'YES',
  'SHOW_USED_FILES'       => 'YES',
  'SKIP_FUNCTION_MACROS'  => 'YES',
  'SORT_MEMBER_DOCS'      => 'YES',
  'SOURCE_BROWSER'        => 'YES',
  'STRIP_CODE_COMMENTS'   => 'YES',
  'STRIP_FROM_PATH'       => '',
  'TAB_SIZE'              => '4',
  'TAGFILES'              => '',
  'TEMPLATE_RELATIONS'    => '',
  'TOC_EXPAND'            => 'NO',
  'TREEVIEW_WIDTH'        => '250',
  'USE_PDFLATEX'          => 'NO',
  'VERBATIM_HEADERS'      => 'YES',
  'WARNINGS'              => 'YES',
  'WARN_FORMAT'           => '',
  'WARN_IF_UNDOCUMENTED'  => 'YES',
  'WARN_LOGFILE'          => '',
};

###============================================================================
###@@ Basic Methods
###============================================================================

sub new
{
  my $type = shift;
  my $self = $doxygen_defaults;
  bless $self, $type;
}

###============================================================================
###@@ Misc Methods
###============================================================================

# Modify config params so that only HTML output will be generated.
sub html_only()
{
  my $self = shift;

  $self->{"GENERATE_HTML"}  	= "YES";
  $self->{"GENERATE_HTMLHELP"} 	= "NO";
  $self->{"GENERATE_LATEX"} 	= "NO";
  $self->{"GENERATE_RTF"}   	= "NO";
  $self->{"GENERATE_MAN"}   	= "NO";
  $self->{"GENERATE_XML"}   	= "NO";
}

# $obj->run_doxygen( dir )
#   dir = directory to which to cd before running doxygen
# This creates the doxygen config file as well.
sub run_doxygen()
{
  my $self = shift;
  my $dir  = shift;
  local *FH;

  open(FH, ">$dir/Doxyfile")
      || die "Can't open $dir/Doxyfile for output";
  $self->print_config_file(FH);
  close(FH);

  print "Running doxygen ...\n";
  print "    INPUT  = $self->{INPUT}\n";
  print "    OUTPUT = $self->{OUTPUT_DIRECTORY}\n";
  my $beg = time;
  system "cd $dir; doxygen Doxyfile;";
  my $end = time;
  my $minutes = int ($end - $beg) / 60;
  my $seconds = ($end - $beg) % 60;
  print "Running doxygen ... done.\n";
  print "Elapsed time is $minutes min $seconds sec.\n";
}

###============================================================================
###@@ Print Configuration File
###============================================================================
#
# print_config_file() is the top-level method.

# Utility used by other function.
sub print_header()
{
  my $self = shift;
  local *FH = shift;
  my ($name) = @_;

  print FH "\n";
  print FH "#----------------------------------------------------------------\n";
  print FH "# $name configuration options\n";
  print FH "#----------------------------------------------------------------\n";
  print FH "\n";
}

# Utility used by other function.
sub print_an_option()
{
  my $self   = shift;
  local *FH  = shift;
  my $name   = shift;
  my $value  = $doxygen_defaults->{"$name"};
  my $spaces = 24 - length($name);
  $spaces = 0 if $spaces < 0;
  print FH "$name" . " " x $spaces . "= " . $value . "\n";
}

sub print_general_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "General");
  $self->print_an_option(FH, "PROJECT_NAME");
  $self->print_an_option(FH, "PROJECT_NUMBER");
  $self->print_an_option(FH, "OUTPUT_DIRECTORY");
  $self->print_an_option(FH, "OUTPUT_LANGUAGE");
  $self->print_an_option(FH, "EXTRACT_ALL");
  $self->print_an_option(FH, "EXTRACT_PRIVATE");
  $self->print_an_option(FH, "EXTRACT_STATIC");
  $self->print_an_option(FH, "HIDE_UNDOC_MEMBERS");
  $self->print_an_option(FH, "HIDE_UNDOC_CLASSES");
  $self->print_an_option(FH, "BRIEF_MEMBER_DESC");
  $self->print_an_option(FH, "REPEAT_BRIEF");
  $self->print_an_option(FH, "ALWAYS_DETAILED_SEC");
  $self->print_an_option(FH, "FULL_PATH_NAMES");
  $self->print_an_option(FH, "STRIP_FROM_PATH");
  $self->print_an_option(FH, "INTERNAL_DOCS");
  $self->print_an_option(FH, "STRIP_CODE_COMMENTS");
  $self->print_an_option(FH, "CASE_SENSE_NAMES");
  $self->print_an_option(FH, "SHORT_NAMES");
  $self->print_an_option(FH, "HIDE_SCOPE_NAMES");
  $self->print_an_option(FH, "VERBATIM_HEADERS");
  $self->print_an_option(FH, "SHOW_INCLUDE_FILES");
  $self->print_an_option(FH, "JAVADOC_AUTOBRIEF");
  $self->print_an_option(FH, "INHERIT_DOCS");
  $self->print_an_option(FH, "INLINE_INFO");
  $self->print_an_option(FH, "SORT_MEMBER_DOCS");
  $self->print_an_option(FH, "DISTRIBUTE_GROUP_DOC");
  $self->print_an_option(FH, "TAB_SIZE");
  $self->print_an_option(FH, "GENERATE_TODOLIST");
  $self->print_an_option(FH, "GENERATE_TESTLIST");
  $self->print_an_option(FH, "GENERATE_BUGLIST");
  $self->print_an_option(FH, "ALIASES");
  $self->print_an_option(FH, "ENABLED_SECTIONS");
  $self->print_an_option(FH, "MAX_INITIALIZER_LINES");
  $self->print_an_option(FH, "OPTIMIZE_OUTPUT_FOR_C");
  $self->print_an_option(FH, "SHOW_USED_FILES");
}

sub print_warnings_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Warnings");
  $self->print_an_option(FH, "QUIET");
  $self->print_an_option(FH, "WARNINGS");
  $self->print_an_option(FH, "WARN_IF_UNDOCUMENTED");
  $self->print_an_option(FH, "WARN_FORMAT");
  $self->print_an_option(FH, "WARN_LOGFILE");
}

sub print_input_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Input");
  $self->print_an_option(FH, "INPUT");
  $self->print_an_option(FH, "FILE_PATTERNS");
  $self->print_an_option(FH, "RECURSIVE");
  $self->print_an_option(FH, "EXCLUDE");
  $self->print_an_option(FH, "EXCLUDE_PATTERNS");
  $self->print_an_option(FH, "EXAMPLE_PATH");
  $self->print_an_option(FH, "EXAMPLE_PATTERNS");
  $self->print_an_option(FH, "EXAMPLE_RECURSIVE");
  $self->print_an_option(FH, "IMAGE_PATH");
  $self->print_an_option(FH, "INPUT_FILTER");
  $self->print_an_option(FH, "FILTER_SOURCE_FILES");
}

sub print_browsing_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Source Browsing");
  $self->print_an_option(FH, "SOURCE_BROWSER");
  $self->print_an_option(FH, "INLINE_SOURCES");
  $self->print_an_option(FH, "REFERENCED_BY_RELATION");
  $self->print_an_option(FH, "REFERENCES_RELATION");
}

sub print_class_index_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Class Index");
  $self->print_an_option(FH, "ALPHABETICAL_INDEX");
  $self->print_an_option(FH, "COLS_IN_ALPHA_INDEX");
  $self->print_an_option(FH, "IGNORE_PREFIX");
}

sub print_html_output_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "HTML Output");
  $self->print_an_option(FH, "GENERATE_HTML");
  $self->print_an_option(FH, "HTML_OUTPUT");
  $self->print_an_option(FH, "HTML_HEADER");
  $self->print_an_option(FH, "HTML_FOOTER");
  $self->print_an_option(FH, "HTML_STYLESHEET");
  $self->print_an_option(FH, "HTML_ALIGN_MEMBERS");
  $self->print_an_option(FH, "GENERATE_HTMLHELP");
  $self->print_an_option(FH, "GENERATE_CHI");
  $self->print_an_option(FH, "BINARY_TOC");
  $self->print_an_option(FH, "TOC_EXPAND");
  $self->print_an_option(FH, "DISABLE_INDEX");
  $self->print_an_option(FH, "ENUM_VALUES_PER_LINE");
  $self->print_an_option(FH, "GENERATE_TREEVIEW");
  $self->print_an_option(FH, "TREEVIEW_WIDTH");
}

sub print_latex_output_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "LaTeX Output");
  $self->print_an_option(FH, "GENERATE_LATEX");
  $self->print_an_option(FH, "LATEX_OUTPUT");
  $self->print_an_option(FH, "COMPACT_LATEX");
  $self->print_an_option(FH, "PAPER_TYPE");
  $self->print_an_option(FH, "EXTRA_PACKAGES");
  $self->print_an_option(FH, "LATEX_HEADER");
  $self->print_an_option(FH, "PDF_HYPERLINKS");
  $self->print_an_option(FH, "USE_PDFLATEX");
  $self->print_an_option(FH, "LATEX_BATCHMODE");
}

sub print_rtf_output_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "RTF Output");
  $self->print_an_option(FH, "GENERATE_RTF");
  $self->print_an_option(FH, "RTF_OUTPUT");
  $self->print_an_option(FH, "COMPACT_RTF");
  $self->print_an_option(FH, "RTF_HYPERLINKS");
  $self->print_an_option(FH, "RTF_STYLESHEET_FILE");
  $self->print_an_option(FH, "RTF_EXTENSIONS_FILE");
}

sub print_man_output_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Man Page Output");
  $self->print_an_option(FH, "GENERATE_MAN");
  $self->print_an_option(FH, "MAN_OUTPUT");
  $self->print_an_option(FH, "MAN_EXTENSION");
  $self->print_an_option(FH, "MAN_LINKS");
}

sub print_xml_output_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "XML Output");
  $self->print_an_option(FH, "GENERATE_XML");
}

sub print_preprocessor_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Preprocessor");
  $self->print_an_option(FH, "ENABLE_PREPROCESSING");
  $self->print_an_option(FH, "MACRO_EXPANSION");
  $self->print_an_option(FH, "EXPAND_ONLY_PREDEF");
  $self->print_an_option(FH, "SEARCH_INCLUDES");
  $self->print_an_option(FH, "INCLUDE_PATH");
  $self->print_an_option(FH, "INCLUDE_FILE_PATTERNS");
  $self->print_an_option(FH, "PREDEFINED");
  $self->print_an_option(FH, "EXPAND_AS_DEFINED");
  $self->print_an_option(FH, "SKIP_FUNCTION_MACROS");
}

sub print_external_ref_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "External Reference");
  $self->print_an_option(FH, "TAGFILES");
  $self->print_an_option(FH, "GENERATE_TAGFILE");
  $self->print_an_option(FH, "ALLEXTERNALS");
  $self->print_an_option(FH, "PERL_PATH");
}

sub print_dot_tool_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Dot tool");
  $self->print_an_option(FH, "CLASS_DIAGRAMS");
  $self->print_an_option(FH, "HAVE_DOT");
  $self->print_an_option(FH, "CLASS_GRAPH");
  $self->print_an_option(FH, "COLLABORATION_GRAPH");
  $self->print_an_option(FH, "TEMPLATE_RELATIONS");
  $self->print_an_option(FH, "HIDE_UNDOC_RELATIONS");
  $self->print_an_option(FH, "INCLUDE_GRAPH");
  $self->print_an_option(FH, "INCLUDED_BY_GRAPH");
  $self->print_an_option(FH, "GRAPHICAL_HIERARCHY");
  $self->print_an_option(FH, "DOT_PATH");
  $self->print_an_option(FH, "DOTFILE_DIRS");
  $self->print_an_option(FH, "MAX_DOT_GRAPH_WIDTH");
  $self->print_an_option(FH, "MAX_DOT_GRAPH_HEIGHT");
  $self->print_an_option(FH, "GENERATE_LEGEND");
  $self->print_an_option(FH, "DOT_CLEANUP");
}

sub print_search_engine_section()
{
  my $self = shift;
  local *FH = shift;
  $self->print_header(FH, "Search Engine");
  $self->print_an_option(FH, "SEARCHENGINE");
  $self->print_an_option(FH, "CGI_NAME");
  $self->print_an_option(FH, "CGI_URL");
  $self->print_an_option(FH, "DOC_URL");
  $self->print_an_option(FH, "DOC_ABSPATH");
  $self->print_an_option(FH, "BIN_ABSPATH");
  $self->print_an_option(FH, "EXT_DOC_PATHS");
}

sub print_config_file()
{
  my $self = shift;
  local *FH = shift;
  my $now_string = localtime;  # e.g. "Thu Oct 13 04:54:34 1994"

  print FH "# Doxygen Configuration File for version 1.2.12\n";
  print FH "# DO NOT EDIT THIS FILE!\n";
  print FH "# It was generated by $this_prog perl script on $now_string.\n\n";

  $self->print_general_section(FH);
  $self->print_warnings_section(FH);
  $self->print_input_section(FH);
  $self->print_browsing_section(FH);
  $self->print_class_index_section(FH);
  $self->print_html_output_section(FH);
  $self->print_latex_output_section(FH);
  $self->print_rtf_output_section(FH);
  $self->print_man_output_section(FH);
  $self->print_xml_output_section(FH);
  $self->print_preprocessor_section(FH);
  $self->print_external_ref_section(FH);
  $self->print_dot_tool_section(FH);
  $self->print_search_engine_section(FH);
}


###****************************************************************************
###@ Samples
###****************************************************************************

# $obj->generate_sample(1) creates ./sample1 directory, creates sample.cpp file
# in that directory, then runs doxygen in that directory.
# $obj->generate_sample(2) and $obj->generate_sample(3) are also valid.
sub generate_sample()
{
  my $self = shift;
  my $num  = shift;
  my $sdir = "sample$num";
  my $cfg   = "$sdir/Doxyfile";
  local *FH;

  mkdir "$sdir" unless -d "$sdir";

  $self->{"PROJECT_NAME"} 	= "Sample #$num";
  $self->{"INPUT"} 		= "$sdir";
  $self->{"OUTPUT_DIRECTORY"} 	= "$sdir";

  $self->{"GENERATE_HTML"}  	= "YES";
  $self->{"GENERATE_HTMLHELP"} 	= "YES";
  $self->{"GENERATE_CHI"} 	= "YES";
  $self->{"GENERATE_LATEX"} 	= "YES";
  $self->{"GENERATE_RTF"}   	= "YES";
  $self->{"GENERATE_MAN"}   	= "YES";
  $self->{"GENERATE_XML"}   	= "YES";

  open(FH, ">$cfg") || die "Can't open $cfg for output";
  $self->print_config_file(FH);
  close(FH);

  if ( $num == 3 )
  {
    # This case should be handled by the "eval" line below.
    # However, this case doesn't work.
    # Don't know why this is the case. -ryk11/30/01.
    $self->create_sample_program3($sdir);
  }
  else
  {
    eval "\$self->create_sample_program$num($sdir);";
  }

  system "doxygen $cfg;";
}

###============================================================================
###@@ Sample #1
###============================================================================

# Private function called by generate_sample().
sub create_sample_program1 ()
{
  my $self  = shift;
  my $sdir  = shift;
  local *FH;
  my $samp  = "$sdir/sample.cpp";

  open(FH, ">$samp") || die "Can't open $samp for output";

  print FH <<EOF;
\#define MAC1 1

typedef enum
{
  ENUM_ONE,
  ENUM_TWO,
  ENUM_THREE,
} EnumOne;

typedef struct
{
  int m_one;
  int m_two;
} StructOne;

int
f1()
{
}

int
f2()
{
}

int
main()
{
    int i, j;
    EnumOne e1;
    StructOne s1;

    f1();
    f2();
}
EOF

    close(FH);
}

###============================================================================
###@@ Sample #2
###============================================================================

# Private function called by generate_sample().
sub create_sample_program2 ()
{
  my $self  = shift;
  my $sdir  = shift;
  local *FH;
  my $samp  = "$sdir/sample.cpp";

  $self->create_sample_header2($sdir);

  open(FH, ">$samp") || die "Can't open $samp for output";

  print FH <<EOF;

\#include "sample.h"
  
/**
 * This is the first function.  f2() is the second.
 * This uses #MAC1 macro.
 */
int
f1()
{
  int i = MAC1;
}

int
f2()
{
}

/**
 * This is the main function.
 * Functions called include:
 * - f1()
 * - f2()
 */
int
main()
{
    int i, j;
    EnumOne e1;
    StructOne s1;

    f1();
    f2();
}
EOF

    close(FH);
}

# Private function.
sub create_sample_header2 ()
{
  my $self  = shift;
  my $sdir  = shift;
  local *FH;
  my $samp  = "$sdir/sample.h";

  open(FH, ">$samp") || die "Can't open $samp for output";

  print FH <<EOF;
/**
 * MAC1 is the first macro.
 */  
\#define MAC1 1

/**
 * EnumOne has three enums.
 */
typedef enum
{
  /**
   * ENUM_ONE is the first enum.
   */
  ENUM_ONE,
  /**
   * ENUM_TWO is the second enum.
   */
  ENUM_TWO,
  /**
   * ENUM_THREE is the third enum.
   */
  ENUM_THREE,
} EnumOne;

/**
 * StructOne has only two members.
 */
typedef struct
{
  int m_one;
  int m_two;
} StructOne;
EOF

    close(FH);
}

###============================================================================
###@@ Sample #3
###============================================================================

# Private function called by generate_sample().
sub create_sample_program3 ()
{
  my $self  = shift;
  my $sdir  = shift;
  local *FH;
  my $samp  = "$sdir/sample.cpp";

  $self->create_sample_header3($sdir);

  open (FH, ">$samp") || die "Can't open $samp for output";

  print FH <<'EOF';

\#include "sample.h"

/**
 * 
 * @mainpage Sample Project
 * 
 * @section intro Introduction
 * 
 * This is @b introduction section.
 * 
 * The second section, @ref sec2, documents the second section.
 * which has a subsection, @ref subsec2, as well.
 * 
 * @section sec2 The Second Section
 * 
 * This is the second section.
 * 
 * @subsection subsec2 The Second Section First Subsection
 * 
 */

/**
 * @defgroup g1 Group1
 *
 * This is the first group created via the @b defgroup command.
 */

/**
 * @defgroup g1a Group1a
 * @ingroup g1
 *
 * This is the first sub group created via the @b defgroup and
 * @b ingroup commands.
 */

/**
 * @defgroup g2 Group2
 *
 * This is the second group created via the @b defgroup command.
 */

/**
 * @defgroup g2a Group2a
 * @ingroup g2
 *
 * This is a sub group created via the @b defgroup and
 * @b ingroup commands.
 * The firs group, @ref g1, comes before this.
 */

/**
 * This is the first function.  f2() is the second.
 * This uses #MAC1 macro.
 */
int
f1()
{
  int i = MAC1;
}

int
f2()
{
}

/**
 * This is the main function.
 * Functions called include:
 * - f1()
 * - f2()
 */
int
main()
{
    int i, j;
    EnumOne e1;
    StructOne s1;

    f1();
    f2();
}
EOF

    close FH;
}

# Private function
sub create_sample_header3 ()
{
  my $self = shift;
  my $sdir = shift;
  local *FH;
  my $samp = "$sdir/sample.h";

  open (FH, ">$samp") || die "Can't open $samp for output";
  
  print FH <<EOF;
/**
 * MAC1 is the first macro.
 */  
\#define MAC1 1

/**
 * EnumOne has three enums.
 */
typedef enum
{
  /**
   * ENUM_ONE is the first enum.
   */
  ENUM_ONE,
  /**
   * ENUM_TWO is the second enum.
   */
  ENUM_TWO,
  /**
   * ENUM_THREE is the third enum.
   */
  ENUM_THREE,
} EnumOne;

/**
 * StructOne has only two members.
 */
typedef struct
{
  int m_one;
  int m_two;
} StructOne;
EOF

    close FH;
}

###****************************************************************************
###@ Documentation
###****************************************************************************

1;

__END__

=head1 NAME

Doxygen - utilities to create doxygen config files and run doxygen.

=head1 SYNOPSIS

    use Doxygen;

    # $dox is a reference to a hash table with doxygen configuration
    # parameters as the key.  The default values should be good for C/C++
    # projects with HTML output only.
    my $dox = Doxygen->new;

    # Any config param can be modified.
    $dox->{"PROJECT_NAME"}     = "Project Name";
    $dox->{"INPUT"}            = "src/include src/common src/project";
    $dox->{"OUTPUT_DIRECTORY"} = "doxygen_out";

    # Run doxygen by taking these steps:
    # - change directory to $dir
    # - create $dir/Doxyfile configuration file
    # - run doxygen
    my $dir = ".";
    $dox->run_doxygen($dir);

    # Other misc methods are described below.

    # Generate ./sample1 directory with a sample C++ file, then run doxygen
    # to generate all output types.
    $dox->generate_sample( 1 );

    $dox->generate_sample( 2 );		# generate ./sample2 tree

    $dox->generate_sample( 3 );		# generate ./sample3 tree

    # Print the configuration file to stdout.
    $self->print_config_file(STDOUT);

=head1 DESCRIPTION

The goal is to allow one to write Perl scripts to control Doxygen easily.

=cut

[Doxygen-develop] Updated TRANSLATOR_DE.H

[Brandt, O. / E. - B. <Oli...@Le...>]

Hello everybody!

Here is an updated version of TRANSLATOR_DE.H.
I've been in contact with the current mantainer
of this translation (Jens Seidel;
jen...@hr...) and he gave his
permission to post this file.

Regards

Oliver Brandt

[Doxygen-develop] tagfiles and external modules

[joe b. <be...@mc...>]

I have been using the external documentation support in doxygen to produce a 
set of API documents for a set of C libraries. In my group, we use modules 
(@defgroup/@ingroup) to associate related parts of the documentation within a 
library, and are trying to use tagfiles to link together the documentation 
for separate libraries which may share data types, or perhaps document links 
to enums or functions from other libraries. However, when using tagfiles to 
link together the documentation, I've run into a couple of problems.

One is that external modules (in another library's tagfile) are showing up in 
the modules page for libraries that use the tagfile. This makes the 
documentation for the higher-level libraries more cluttered. The first 
attachment is a patch which disables the listing of external modules in the 
module page.

I'm also having problems linking to external functions and typedefs (structs 
are ok). The second attachment is a tarfile containing two sample modules, 
the second one which refers to a typedef, function, and struct in the first. 
If you create the documentation (make will do so) and look at the 
documentation in modules2/html/group__module2.html, you can see that links 
are not made for all of the elements in the tagfile (links foo and bar in 
particular are missing). I didn't make much progress in a quick check to find 
out why this was happening.

thanks,
joe

[Doxygen-develop] Portuguese translation update

[Rui L. <rui...@ya...>]

In the attachament is the updated Portuguese
translation.



=====
Rui Lopes
www.rgl.f2s.com

__________________________________________________
Do You Yahoo!?
Yahoo! GeoCities - quick and easy web site hosting, just $8.95/month.
http://geocities.yahoo.com/ps/info1

[Doxygen-develop] Not going to make changes to doxygen

[Carlo W. <ca...@al...>]

On Tue, Nov 27, 2001 at 02:33:49AM +0100, Carlo Wood wrote:
> 1) checkout the latest CVS, configure and compile it
>    and create a test environment that I can work with.

After a closer investigation of my problem, I finally found
out that in most cases doxygen is doing the right thing.
It was very unclear WHEN doxygen will lookup variables/functions/classes
etc. and where it would look etc.  Because I ran often into
cases that it did not work I concluded that it was broken in
general :/.

Fortunately, it seems that doxygen mostly is doing an excellent
job in finding the right classes when referenced in the
documentation (without using the namespace they are in).

It doesn't work inside a @addtogroup inside a namespace;
apparently the fact that this happens inside a namespace is ignored.
But now I know that, I can't afford to put time into that.

I still don't understand when doxygen needs a '\ref'
command to do a lookup (in some cases it seems to make a link
to simple words (like the 'A' in the example my previous post)
while in other cases I need to add an explicit '\ref'... weird.

Back to his own project,

-- 
Carlo Wood <ca...@al...>

[Doxygen-develop] Going to make changes to doxygen

[Carlo W. <ca...@al...>]

Hiya,

I just decided to spend some of my time on doxygen,
and therefore subscribed to doxygen-develop.

Normally I first ask what is the chance that a patch
will be added, but in this case I need the patch
hard enough to make it worthwhile if only I would
be one who'd use it, so I'll write it anyway ;).

The first thing I plan to write is a better support
for namespaces:

Instead of searching global namespace only, I want
doxygen to search the _current_ namespace first,
and then the global namespace.  Thus:

class FOOBAR;

namespace n {
  class FOOBAR;

  /**
   * A pointer to class FOOBAR.
   */
  FOOBAR* p;
}

Should generate documentation with a link
to n::p and not ::p.

My plans so far are:

0) subscribe to this list and introduce myself.
1) checkout the latest CVS, configure and compile it
   and create a test environment that I can work with.
2) read the documentation on www.doxygen.org for
   developers.

I am afraid I am not very good at introducing myself
so you might want to read the 1116 pages that show up on
http://www.altavista.com/sites/search/web?q=%22Carlo+Wood%22+AND+NOT+Vendors&kl=XX&r=&d2=0&d0=&d1=&nbq=20&pg=aq&search=Search
or perhaps just the links of my introduction at the bottom
of http://www.gnu.org/people/people.html

-- 
Carlo Wood <ca...@al...>

[Doxygen-develop] Info on the status of language translators (updated repost)

[Prikryl,Petr <PRI...@sk...>]

(This is a repost of the updated message.  The attached
translator_report.txt
reflects the status of 1.2.12-20011125.  Six maintainers updated their
language
since the previous post -- thanks.)

> Hallo to the language maintainers,
> 
> (zipped translator_report.txt attached)
> 
> I am sending this as a reminder of status of the
> translator classes for the supported languages
> (files translator_xx.h).  New method  was added 
> to the Translator class since doxygen 1.2.11.
> Because of this, many language translators 
> are considered obsolete again.  
> 
> The doxygen/doc/translator.pl script can help you
> what methods should be implemented and what 
> methods should be removed in your TranslatorXxx
> class. (One of the results, the translator report, is 
> attached to this message.)
> 
> I would like to express my explicit thanks to those
> who has the version of their translator class equal
> to 1.2.7 or better.
> 
> I would like to encourage those with version between
> 1.2.0 to 1.2.7.  It seems that it is a good time to 
> update your translator.
> 
> I would like to ask the language maintainers of the 
> languages with the translator version below 1.2.0.
> Please, try to update your translator.  Even though
> there is a mechanism to replace the missing 
> functionality, the really obsolete translators make
> doxygen a bit more complicated than necessary.
> It can also further complicate the near-future 
> development of the language support.  You may 
> be too busy to do that, no shame -- you gave your
> time for free to other user.  If you know that you 
> are not able to update your translator class, please,
> try to find another maintainer for your language, or 
> let us know that you cannot or do not want to continue
> to maintain your part of code.  I am sure that you will
> not be blamed for that, and your name will still be 
> carved inside the sources ;-)
> 
> Now, many thanks to those who keep their translators
> up-to-date, and also to those who will make it up-to-date
> really soon ;-)  
> 
> You can find the zipped translator_report.txt
> attached to this message.  The content basically says 
> what methods are to be implemented and what methods
> should be removed (never used).
> 
>  <<tr_rep.zip>> 
> Here is the snippet from inside that lists up-to-date
> translators (CVS and plus some updates sent to this list).
> 
----------------------------------------------------------------------
The following translator classes are up-to-date (sorted alphabetically).
This means that they derive from the Translator class.  Anyway, there still
may be some details listed even for the up-to-date translators.
Please, check the text below if the translator is marked so.

  TranslatorBrazilian
  TranslatorCroatian
  TranslatorCzech
  TranslatorDutch
  TranslatorEnglish
  TranslatorFrench
  TranslatorItalian
  TranslatorKorean
  TranslatorPortuguese  -- see details below in the report
  TranslatorRussian     -- see details below in the report
  TranslatorSlovene
----------------------------------------------------------------------
The following translator classes are obsolete (sorted alphabetically).
This means that they derive from some of the adapter classes.

  TranslatorChinese     (TranslatorAdapter_1_2_11)
  TranslatorDanish      (TranslatorAdapter_1_2_7)
  TranslatorFinnish     (TranslatorAdapter_1_0_0)
  TranslatorGerman      (TranslatorAdapter_1_2_11)
  TranslatorHungarian   (TranslatorAdapter_1_2_1)
  TranslatorJapanese    (TranslatorAdapter_1_2_5)
  TranslatorNorwegian   (TranslatorAdapter_1_2_2)
  TranslatorPolish      (TranslatorAdapter_1_2_1)
  TranslatorRomanian    (TranslatorAdapter_1_2_1)
  TranslatorSlovak      (TranslatorAdapter_1_2_11)
  TranslatorSpanish     (TranslatorAdapter_1_2_7)
  TranslatorSwedish     (TranslatorAdapter_1_0_0)
  TranslatorUkrainian   (TranslatorAdapter_1_2_11)
----------------------------------------------------------------------

> The "see details below in the report" generally means that there are 
> probably some obsolete methods (should be removed).
> Here the Russian is the exception, because it implements
> some new, experimental methods, that were recognized as
> obsolete (they are not found in the abstract Translator class
> in translator.h).  Read doxygen/html/langhowto.html 
> (the part of doxygen documentation) for details.
> 
> And finally, many thanks to those (of course), 
> who work on other parts of doxygen, i.e. not the
> language translation.  You know, who you are, and you 
> know on what you work ;-)
> 
> See you, 
>   Petr
> -- 
> Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)
> 

[Doxygen-develop] translator_br.h

[FJTC (F. J. T. Chino) <ch...@ic...>]

Hi.

Here goes the new version of translator_br.h.

See you.
FJTC

----------------------------------------------------------------------
         FJTC (Fabio Jun Takada Chino) - ch...@ic...
      Computer Science - ICMC - University of Sao Paulo - Brazil
              GBDI - Grupo de Base de Dados e Imagens
----------------------------------------------------------------------
Homepage
  http://www.icmc.sc.usp.br/~chino (main)
  http://gbdi.icmc.sc.usp.br/ (GBDI)
  http://www.fjtc.hpg.com.br/ (Anime - Portuguese Only)
  http://www.bbits.hpg.com.br/ (Game Programming - English Only)
======================================================================

[Doxygen-develop] Portuguese translation updated

[Rui L. <rui...@ya...>]

Hi!

Just to send the updated Portuguese translator file.


Byes! And Happy codding!




=====
Rui Lopes
www.rgl.f2s.com

__________________________________________________
Do You Yahoo!?
Yahoo! GeoCities - quick and easy web site hosting, just $8.95/month.
http://geocities.yahoo.com/ps/info1

[Doxygen-develop] grouping with c-based project

[Stefan K. <ko...@im...>]

the recent posting about grouping, made me reading that part of the docs again
and adding @defgroup and @ingroup statements to my c-sources. The problem is that
I can get any module documentation (the modules link in the navbar) to show up in
the generated docs, like shown in "doxygen/examples/group/html/modules.html".
That is what doxygen does after generating the doc files :

Generating class documentation...
Generating annotated compound index...
Generating alphabetical compound index...
Generating hierarchical class index...
Generating member index...
Generating docs for compound GitkContext...
Generating docs for compound GitkElements...
Generating page documentation...
Generating docs for page todo...
Generating group documentation...
Generating namespace index...
Generating group index...
Generating package index...
Generating example index...
Generating file member index...
Generating namespace member index...
Generating page index...
Generating graph info page...
Generating search index...
Generating style sheet...
Generating graphical class hierarchy...

Stefan
-- 
       \|/
      <@ @> Stefan Kost  private                   business
+-oOO-(_)-OOo------------------------------------------------------------- - - -  -   -
|        __    Address  Zwenkauer Str. 24         HTWK Leipzig, Fb IMN, Postfach 300066
|       ///             04277 Leipzig             04277 Leipzig
|  __  ///              Germany                   Germany
|  \\\///      Phone    +49341 3910483            +49341 3076101
|   \__/       EMail    st...@gm...           ko...@im...
|              WWW      http://www.sonicpulse.de  http://www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

[Doxygen-develop] Korean translation updated

[Richard Y. K. <ry...@ds...>]

Hi,

I simply deleted obsoleted methods and copied the new ones from the
English file translator_en.h.
I need to translate the strings in the new methods, but this will
have to wait because I need to consult other people on correct
translation. I will try to get this done ASAP.

[Doxygen-develop] Italian translation update

[Alessandro F. <afa...@da...>]

Hi all,
	here is the update of the italian translation in response to the reminder
sent out by Petr (invaluable indeed!).

Alessandro

[Doxygen-develop] French translation update

[Xavier O. <xav...@an...>]

Ahoj Petre,

Please found the update version of translator_fr.h.

Cau,

Xavier.
--
 D2SET Scientific and Technical Non profit Association
  http://www.d2set.org/
  mailto:d2...@d2...

 Artificial Anthill Project
  http://www.aanthill.org/
  mailto:aan...@aa...

"Prikryl,Petr" wrote:
> 
> Hallo to the language maintainers,
[...]
>   TranslatorFrench      -- see details below in the report
[...]

[Doxygen-develop] Info on the status of language translators, my thanks to the lang uage maintainers

[Prikryl,Petr <PRI...@sk...>]

Hallo to the language maintainers,

(zipped translator_report.txt attached)

I am sending this as a reminder of status of the
translator classes for the supported languages
(files translator_xx.h).  New method  was added 
to the Translator class since doxygen 1.2.11.
Because of this, many language translators 
are considered obsolete again.  

The doxygen/doc/translator.pl script can help you
what methods should be implemented and what 
methods should be removed in your TranslatorXxx
class. (One of the results, the translator report, is 
attached to this message.)

I would like to express my explicit thanks to those
who has the version of their translator class equal
to 1.2.7 or better.

I would like to encourage those with version between
1.2.0 to 1.2.7.  It seems that it is a good time to 
update your translator.

I would like to ask the language maintainers of the 
languages with the translator version below 1.2.0.
Please, try to update your translator.  Even though
there is a mechanism to replace the missing 
functionality, the really obsolete translators make
doxygen a bit more complicated than necessary.
It can also further complicate the near-future 
development of the language support.  You may 
be too busy to do that, no shame -- you gave your
time for free to other user.  If you know that you 
are not able to update your translator class, please,
try to find another maintainer for your language, or 
let us know that you cannot or do not want to continue
to maintain your part of code.  I am sure that you will
not be blamed for that, and your name will still be 
carved inside the sources ;-)

Now, many thanks to those who keep their translators
up-to-date, and also to those who will make it up-to-date
really soon ;-)  

You can find the zipped translator_report.txt
attached to this message.  The content basically says 
what methods are to be implemented and what methods
should be removed (never used).

 <<tr_report.zip>> 
Here is the snippet from inside that lists up-to-date
translators (CVS and plus some updates sent to this list).

----------------------------------------------------------------------
The following translator classes are up-to-date (sorted alphabetically).
This means that they derive from the Translator class.  Anyway, there still
may be some details listed even for the up-to-date translators.
Please, check the text below if the translator is marked so.

  TranslatorCroatian
  TranslatorCzech
  TranslatorEnglish
  TranslatorFrench      -- see details below in the report
  TranslatorPortuguese  -- see details below in the report
  TranslatorRussian     -- see details below in the report
----------------------------------------------------------------------

The "see details below in the report" generally means that there are 
probably some obsolete methods (should be removed).
Here the Russian is the exception, because it implements
some new, experimental methods, that were recognized as
obsolete (they are not found in the abstract Translator class
in translator.h).  Read doxygen/html/langhowto.html 
(the part of doxygen documentation) for details.

And finally, many thanks to those (of course), 
who work on other parts of doxygen, i.e. not the
language translation.  You know, who you are, and you 
know on what you work ;-)

See you, 
  Petr
-- 
Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)

[Doxygen-develop] Errors when running make on a SCO 5.0.4 with gcc 2.95

[Marian G. <Mar...@di...>]

Hi,
First time when I run make I get this error:

rm -f ../lib/libdoxygen.a
ar cq ../lib/libdoxygen.a ../objects/ce_lex.o ../objects/ce_parse.o
../objects/classdef.o ../objects/classlist.o ../objects/code.o
../objects/cppvalue.o ../objects/debug.o ../objects/declinfo.o
../objects/defargs.o ../objects/define.o ../objects/definition.o
../objects/diagram.o ../objects/doc.o ../objects/dot.o ../objects/doxygen.o
../objects/entry.o ../objects/filedef.o ../objects/filename.o
../objects/formula.o ../objects/ftvhelp.o ../objects/gifenc.o
../objects/groupdef.o ../objects/htmlgen.o ../objects/htmlhelp.o
../objects/image.o ../objects/index.o ../objects/instdox.o
../objects/language.o ../objects/latexgen.o ../objects/logos.o
../objects/mangen.o ../objects/memberdef.o ../objects/membergroup.o
../objects/memberlist.o ../objects/membername.o ../objects/message.o
../objects/namespacedef.o ../objects/outputgen.o ../objects/outputlist.o
../objects/packagedef.o ../objects/pre.o ../objects/reflist.o
../objects/rtfgen.o ../objects/scanner.o ../objects/searchindex.o
../objects/suffixtree.o ../objects/tagreader.o ../objects/translator.o
../objects/util.o ../objects/version.o ../objects/xmlgen.o 
ranlib ../lib/libdoxygen.a
/usr/local/bin/ranlib: /defs: not found
gmake[2]: *** [../lib/libdoxygen.a] Error 1
gmake[2]: Leaving directory `/doxygen/doxygen-1.2.12/src'
gmake[1]: *** [all] Error 2
gmake[1]: Leaving directory `/doxygen/doxygen-1.2.12/src'
make: *** [all] Error 2

Second time when running make I get this error:

/usr/local/bin/gmake -f Makefile.doxygen    all
gmake[2]: Entering directory `/doxygen/doxygen-1.2.12/src'
g++ -c -Wall -W -O2 -I../qtools -I. -o ../objects/main.o main.cpp
g++  -o ../bin/doxygen ../objects/main.o  -L../lib -ldoxygen -ldoxycfg
-lqtools 
Undefined                       first referenced
 symbol                             in file
exception virtual table             ../lib/libgcc.a(opnew.o)
__check_eh_spec                     ../lib/libgcc.a(opdel.o)
__eh_alloc                          ../lib/libgcc.a(opnew.o)
exception::what(void) const         ../lib/libgcc.a(tinfo.o)
__cp_pop_exception                  ../lib/libgcc.a(opdel.o)
exception type_info node            ../lib/libgcc.a(tinfo.o)
terminate(void)                     ../lib/libdoxygen.a(doxygen.o)
__start_cp_handler                  ../lib/libgcc.a(opdel.o)
exception type_info function        ../lib/libgcc.a(tinfo.o)
__cp_push_exception                 ../lib/libgcc.a(opnew.o)
../bin/doxygen: fatal error: Symbol referencing errors. No output written to
../bin/doxygen
collect2: ld returned 1 exit status
gmake[2]: *** [../bin/doxygen] Error 1
gmake[2]: Leaving directory `/doxygen/doxygen-1.2.12/src'
gmake[1]: *** [all] Error 2
gmake[1]: Leaving directory `/doxygen/doxygen-1.2.12/src'
make: *** [all] Error 2

Any idea is greatly appreciated. Thanks in advance. On the same system with
the same gcc I was able to compile graphiz.

----------------------------------------------------------
Marian Gutica
Direct: (604)214-7265
E-mail: mar...@di...
----------------------------------------------------------

[Doxygen-develop] Re: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)

[Toni M. <ton...@wa...>]

> Let me add a big ditto to most of this.  Doxygen is great, but I find i=
t
> is almost, but not quite there for documenting C code.

I'm agree. But I think not much work is needed to get a better C=20
documentation using doxygen. =20
About Object Oriented C style , I think is not needen because we can work=
 on=20
\defgroup and \addgroup , to get a good doc structure. ( avoiding use the=
=20
\file tag) .

Inheritance structures can be easyly made using \ingroup ( Is what I'm do=
ing).

And I only miss , control on the order of modules or groups.

Y have put the correct order in my INPUT section
but the order in the tree browser is in reverse order (Perhaps a BUG????)

My input section....
------------------------------------
INPUT     =3D        ./src/gsound.h \    <---here  \defgroup Gsound Init
                       ./src/gsmathdefs.h \  <--- here \defgroup Gsound u=
tils
                       ./src/data/gsdata.h \	<--here \gsdata
                       ./src/data/gsdataformat.h \	<--here \GsDataFormat
                      ./src/data/gsdatachannelsys.h \
                      ./src/data/gsdatatimeenv.h \
                      ./src/data/gsdatatime.h \
                      ./src/data/gsdatabuffer.h \
                     ./src/data/gsdatawave.h \
		etc...
		....

This is the output tree browser:
-------------------------------------------
MODULES (browser)

....
Gsound Basics and Tools.=20
	Gsound Constants and utils=20
	Gsound Initialization.  <----First defined and last in the browser
GSound : Basic Data Types=20
	GsDataWave=20
	GsDataBuffer=20
	GsDataTime=20
	GsDataTimeEnv=20
	GsDataChannelSys=20
	GsDataFormat     <----First defined and last in the tree browser
.....
etc
.....
---------------------------------------------

--=20
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Toni Moreno Gim=E9nez
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Pje de las rosas  n=BA 22
Vilassar de Mar=20
(Barcelona) Espa=F1a
CP: 08340

[Doxygen-develop] Re: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)

[Toni M. <ton...@wa...>]

El Mar 20 Nov 2001 06:25, Dean Povey escribi=F3:
> <snip>
>
> Let me add a big ditto to most of this.  Doxygen is great, but I find i=
t
> is almost, but not quite there for documenting C code.
>
> >2) * hide Macro definitions body. ( and document them like functions )
>
> You can hide macro body with @hideinitializer.  It would be good to be =
able

/** \def GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES
*       \hideinitializer
*/

the outputs is....

 #define GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES( __fmt )=20
Value:({ register guint __v;                                          \
         if ( (((__fmt) & FORMAT_BYTEORDER_LE)>>4) ^                    \
              (((__fmt) & FORMAT_BYTEORDER_BE)>>5) )                    \
         __v=3D((__fmt) & ~GSDATAFORMAT_BYTEORDER_MASK);                 =
 \
         else __v=3D(__fmt);                                             =
 \
         __v;                                                           \
         })

I CAN'T HIDE MACRO BODY....=20

> to add information about the type of macro parameters and expected retu=
rns
> where relevant.  Also it would be nice to be able to abstract the fact =
that
> a macro is a macro and not a function, as sometimes you want to switch
> between functions and macros.

The internal designs don't let me do so.

if you see this.

#define GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES( __fmt )=20
	__fmt : a format enum
	macro returns:  the same format without endiantes format info.

you are completely sure that your are using a Macro not a function.


--=20
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Toni Moreno Gim=E9nez
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Pje de las rosas  n=BA 22
Vilassar de Mar=20
(Barcelona) Espa=F1a
CP: 08340