Hi,
>
> I'm not sure what you intend to do. Do you have pre-existing
> documentation? The "documentation" feature you found is about slurping
> comments out of code that may provide some clues about some function. If you
> have some other doc, then that API isn't useful.
>
hi Eric, actually would like to do couple things, extract doxygen comments
(very similar to Javadoc) and pull-up documentation for installed libraries.
>
> Also, note that there is no fancy API for displaying documentation in
> CEDET. That's one of those things no-one has gotten to. It is used by a
> couple side features, like in speedbar or `semantic-ia-show-doc'. If those
> are the features you want to use, then you are in luck.
>
yes, this is what I want.
>
> As for overriding semantic-documentation-for-tag, I suspect this is not
> what you want. Overridable functions are for overriding on a per-mode
> basis. You seem to want to override that feature on a per tag, or per
> feature basis, as you only have a subset of all documentation needed for
> C++.
>
> If you really do want to override it, there is a fine example in
> semantic/bovine/semantic-java.el. That function happens to also extract
> comments, but it should provide the basics of what creating an override is
> like.
>
thank you, I will start with that
>
> If your STL doc happens to be in .texi files, then there is some
> infrastructure already for navigating between those two types of files.
>
yes, I know of man and info. unfortunately by default STL documentation
comes in HTML and boost seems to only have HTML .
>
> If you intend to create the missing user interface to navigate between
> Semantic derived documentation and some C++/STL feature, that's spiffy. In
> that case, you don't need to override semantic-documentation-for-tag. It
> should be ok to just use it, and you may be wondering instead where to get
> tags to derive documentation from.
>
I do not understand this sentence well. what I would like to do is provide
documentation for a specific tag inside Emacs, to avoid jumping to browser.
right now I use w3m, but it lacks context.
>
> Anyway, more details needed for an answer.
>
> Eric
>
I have look through this week through Java and maybe I will have something
to contribute.
thanks.
|