Re: ANN: Doxygen for MacOS X with Objective-C support
Re: ANN: Doxygen for MacOS X with Objective-C support
- Subject: Re: ANN: Doxygen for MacOS X with Objective-C support
- From: Serge Cohen <email@hidden>
- Date: Sun, 27 Nov 2005 13:52:20 +0100
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hello;
In this post you were saying that you planned to support the parsing
of @implemenation blocks in Obj-C.
I understand that this would enable the documentation of a method to
be in front of it's implementation (rather than in front of the
declaration of the method, in the header file).
Do I understand this item of the todo list properly? Did you had time
to implement it?
I've downloaded the latest Doxygen binary for OS-X, and tried to run
it on the sources of a new application I'm developing, but I don't
manage to get the documentation that is in the .m file into the
generated pages. Is this normal, or am I missing something?
If you this is not feasible in the current version, would it be easy
for me to add that to Doxygen (ie. by tweaking scanner.l, as you
mention in the doc), would you have time to give me some directions?
Thank you for releasing Doxygen (I already happily use it a lot for C+
+, and looking forward to get the same with Obj-C).
Serge.
Le 15 févr. 04 à 22:56, Dimitri van Heesch a écrit :
On Sun, Feb 15, 2004 at 03:23:40PM -0500, T Reaves wrote:
For those among us ignorant of such things (myself included), I was
wondering if you would elaborate a bit more on what your email means.
As I'm looking for a documentation tool, I will be looking at this.
Would you answer a few questions?
1) Is there a timeline for full Objective-C support? I would assume
that is why Apple is supporting it.
I'm working towards that end, but I can give you no exact timeline.
2) What state is the current support? Which features can / can
not be
used? I realize .m file parsing has yet to be added, but I've no
idea
what the implications of that are.
If you limit yourself to feeding doxygen header files only, the
support is
quite complete already. There is support for parsing interfaces,
protocols, and categories. Of course all commands inside a
documentation
block are supported too and the output of Objective-C code should look
ok (but here there might be room for some improvements).
What is still on the todo list:
- support for parsing @implementation blocks and matching method
declaration
against definition, so that you could put all documentation in
a .m file
if you wanted to.
- source browsing support, including cross-referencing, and call-graph
generation (as far as that is possible in a dynamic language like
Objective-C anyway).
- some specific Objective-C relations, such as presenting a list
with all
methods of a class including those from categories (if anyone
thinks that is
useful).
- whatever you think of, which is why I invite you to try the
current version
and not wait until it is "finished".
Regards,
Dimitri
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/
listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Darwin)
iD8DBQFDiawK5EPeG5y7WPsRAlLAAKDEarhtd0eFAV0GxhnuGH9gLn/newCfTzBq
EtSnYRTbosP1qjFF+WzdX0I=
=J0rW
-----END PGP SIGNATURE-----
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden