Kevin McBride | 2 Jan 2008 17:36

test

This is a test

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Nigel Pearson | 9 Jan 2008 01:03
Picon

Perl/Sh parser


Hi guys. Happy new year!

I am one of the MythTV developers, and some
of us use Doxygen in the project a lot.
The MythTV source code has C, C++, Obj-C,
plus a contrib directory with the usual
assortment of Perl, Shell and Python scripts.

I'm also a Perl hacker from way-back,
and used to use a simple inhouse tool
to generate manpages and HTML from custom
markup in our Perl and Shell scripts.
(this was in the days before POD)

So, I would like to start adding Perl/Sh parsing.
I am lumping these together because they have
similar comment parsing requirements,
and I am hoping that one parser can do both.
A few questions to help give me direction:

1) How do we feel about adding a parser
that just summarises a language
instead of trying to parse every little
feature that they have crammed in there?
(e.g. subroutines and markup instead of
       full OO, type matching, blessed modules)

2) I have little idea of where
to start. The structure of the parsers
is a little confusing - I can't work out
how the stuff generated from pyscanner.l
or fortranscanner.l is called, for example.
Any relevant doco, discussion or advice?

3) For a project like MythTV, I don't
want symbols in the scripted stuff to
be references to the compiled stuff.
(e.g. if a Perl script has a usage() routine,
       it is in no way related to a C function
       which is also named usage() or _usage() )
How does the PHP parser deal with this?

Hacky first steps attached:

% diff -ru doxygen-1.5.4.orig doxygen-1.5.4 >doxy.perl.1.patch

--
Nigel Pearson, nigel <at> ind.tansu.com.au|"People say I'm strange,
Telstra Net. Eng., Sydney, Australia | does it make me a stranger?
Office: 9202 3900    Fax:  9261 3912 | My best friend was born...
Mobile: 0408 664435  Home: 9792 6998 |     in a manger"   -DC Talk

Attachment (doxy.perl.1.patch): application/octet-stream, 3455 bytes
-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Dimitri Van Heesch | 12 Jan 2008 13:58
Picon
Gravatar

Re: Perl/Sh parser

Hi Nigel,

On 9 jan 2008, at 01:03, Nigel Pearson wrote:

>
> Hi guys. Happy new year!
>
>
> I am one of the MythTV developers, and some
> of us use Doxygen in the project a lot.
> The MythTV source code has C, C++, Obj-C,
> plus a contrib directory with the usual
> assortment of Perl, Shell and Python scripts.
>
> I'm also a Perl hacker from way-back,
> and used to use a simple inhouse tool
> to generate manpages and HTML from custom
> markup in our Perl and Shell scripts.
> (this was in the days before POD)
>
>
> So, I would like to start adding Perl/Sh parsing.
> I am lumping these together because they have
> similar comment parsing requirements,
> and I am hoping that one parser can do both.
> A few questions to help give me direction:
>
>
> 1) How do we feel about adding a parser
> that just summarises a language
> instead of trying to parse every little
> feature that they have crammed in there?
> (e.g. subroutines and markup instead of
>      full OO, type matching, blessed modules)

You typically need to be able to parse every little detail in order
to create a summary (and ignore the rest). This is especially true for  
scripts and perl,
where there does not need to be any structure (i.e. you can just
start with statements, outside of functions or classes).

>
> 2) I have little idea of where
> to start. The structure of the parsers
> is a little confusing - I can't work out
> how the stuff generated from pyscanner.l
> or fortranscanner.l is called, for example.
> Any relevant doco, discussion or advice?

Look at src/parserintf.h that is the main interface for
implementing new parsers. A parser is registered in initDoxygen, like so

Doxygen::parserManager->registerParser(".f90", new  
FortranLanguageScanner);

whenever doxygen find a file with the .f90 extension is will invoke  
the methods
of the FortranLanguageScanner to parse the file.

>
> 3) For a project like MythTV, I don't
> want symbols in the scripted stuff to
> be references to the compiled stuff.
> (e.g. if a Perl script has a usage() routine,
>      it is in no way related to a C function
>      which is also named usage() or _usage() )
> How does the PHP parser deal with this?

You typically do not make a doxygen project containing multiple  
languages,
so then this is not an issue.

Regards,
   Dimitri

-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://ad.doubleclick.net/clk;164216239;13503038;w?http://sf.net/marketplace
Bryon Roche | 17 Jan 2008 12:33

Doxygen git repo

Hello all, I have a bugfix IRT python support in doxygen, in the gnome
Bugzilla, #331674, and since it appears that the svn repo is taking
forever to come back up, would it be helpful to put a git server
online?  I have a host and disk I can provide this on.  For the moment
I'm building a repo of the released versions from the stack.nl FTP.  If
anyone has a git-svn or svk mirror they could share with me to build a
better history, that would be handy.  Would this be useful?

/B
--

-- 
--
Fhcre Fcl
<kain <at> kain.org>
FE0D EC23 6464 726A CD54  48D3 04AD 86FE 6878 ABD5

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
Pablo Yamamoto | 21 Jan 2008 10:30
Picon

Re: Interest in new XML format for Doxygen export

Hi all,

I came across to this thread since we have tons of doxygen HTML documentation and we want to integrate it with
other documents. We are introducing DITA in our system and a clearly structured doxygen-XML would be the
right starting point.

I don't know how long it would take to get the new doxygen XML format but I am positively interesting in
producing deliverables very soon, and some other DITA-colleagues as well, so if anyone else is working
also on that we could join forces to develop some stylesheet to process the current XML.

Best Regards,

Pablo

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
Jason McKesson | 22 Jan 2008 07:05
Picon

Re: Interest in new XML format for Doxygen export

Well, as much as I would like to, there's not much I can do to help. I 
can't build Doxygen, so I can't update from my current version to one 
that I could produce a patch for and submit it. I gave the code to Ted 
Drain, who seemed interested in making a proper patch for Doxygen, but I 
haven't heard back from him about it.

And the current XML is just not appropriate for any reasonable 
conversion process. You can turn it into something that looks like the 
current Doxygen documentation, but you would never be able to do 
anything freeform with it. Not through XSLT alone.

Pablo Yamamoto wrote:
> Hi all,
>
> I came across to this thread since we have tons of doxygen HTML documentation and we want to integrate it
with other documents. We are introducing DITA in our system and a clearly structured doxygen-XML would be
the right starting point.
>
> I don't know how long it would take to get the new doxygen XML format but I am positively interesting in
producing deliverables very soon, and some other DITA-colleagues as well, so if anyone else is working
also on that we could join forces to develop some stylesheet to process the current XML.
>
> Best Regards,
>
> Pablo
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2008.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Doxygen-develop mailing list
> Doxygen-develop <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop
>
>   

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
Ted Drain | 22 Jan 2008 18:13
Picon
Picon
Favicon

Re: Interest in new XML format for Doxygen export

Sorry - I'm still here an interested.  We're just in the middle of a
critical delivery so I haven't had to time to get to it.  I should have time
at the end of this week or early next week to update the patches.

> -----Original Message-----
> From: doxygen-develop-bounces <at> lists.sourceforge.net [mailto:doxygen-
> develop-bounces <at> lists.sourceforge.net] On Behalf Of Jason McKesson
> Sent: Monday, January 21, 2008 10:06 PM
> To: Pablo Yamamoto
> Cc: doxygen-develop <at> lists.sourceforge.net
> Subject: Re: [Doxygen-develop] Interest in new XML format for Doxygen
> export
> 
> Well, as much as I would like to, there's not much I can do to help. I
> can't build Doxygen, so I can't update from my current version to one
> that I could produce a patch for and submit it. I gave the code to Ted
> Drain, who seemed interested in making a proper patch for Doxygen, but
> I
> haven't heard back from him about it.
> 
> And the current XML is just not appropriate for any reasonable
> conversion process. You can turn it into something that looks like the
> current Doxygen documentation, but you would never be able to do
> anything freeform with it. Not through XSLT alone.
> 
> Pablo Yamamoto wrote:
> > Hi all,
> >
> > I came across to this thread since we have tons of doxygen HTML
> documentation and we want to integrate it with other documents. We are
> introducing DITA in our system and a clearly structured doxygen-XML
> would be the right starting point.
> >
> > I don't know how long it would take to get the new doxygen XML format
> but I am positively interesting in producing deliverables very soon,
> and some other DITA-colleagues as well, so if anyone else is working
> also on that we could join forces to develop some stylesheet to process
> the current XML.
> >
> > Best Regards,
> >
> > Pablo
> >
> > ---------------------------------------------------------------------
> ----
> > This SF.net email is sponsored by: Microsoft
> > Defy all challenges. Microsoft(R) Visual Studio 2008.
> > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> > _______________________________________________
> > Doxygen-develop mailing list
> > Doxygen-develop <at> lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/doxygen-develop
> >
> >
> 
> 
> -----------------------------------------------------------------------
> --
> This SF.net email is sponsored by: Microsoft
> Defy all challenges. Microsoft(R) Visual Studio 2008.
> http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
> _______________________________________________
> Doxygen-develop mailing list
> Doxygen-develop <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/

Gmane