Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cdt-core-dev] Another Parser Document

----- Original Message -----
From: "Mike Capp" <aphelion@xxxxxxxxxxx>
>
> Okay, I got sidetracked there. My point, I think, is that a doc tool
> which isn't Doxygen does not require everyone with investments in
> Doxygen-style doc comments to tear them up and rewrite them. It should
> be possible to reinvent the wheel without also reinventing all the
> roads.
>

The original question was "what is a common mark-up in code".  The initial
query comes from wanting to be able to show inline comments so that
when I do ctrl+space and I get a context list of functions/members/variables
that I can also get whatever "live" (ie in code) comments are available as
well.

Long term we shouldn't have any specific binding, but like everything else
it should be a plugable syntax thing (ie we feed the comment to you, you
parse and tell us something).  For a first (second?) cut however a quick and
dirty answer is needed which people can start shipping in products and which
can be used to draw C/C++ developers into Eclipse.

My vote stays with:
1) JavaDoc -- since it is supported from JDT it should be easy to lift
2) Doxygen -- used by a lot of open source projects

where I would definitely consider 2) something that could be a contributed
piece after the framework for 1) is done.

Just my two cents,
  Thomas



Back to the top