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

John Camelon wrote:

HTML format only, for those who wish to know about what I'm doing. Questions, comments, criticisms and well-tempered abuse are always welcome.
First off, thanks for putting the doc together; even as a complete layman re the CDT internals I found it very clear and informative.

Only one question/suggestion: I was slightly disappointed by the absence of an acceptComment() on ISourceElementRequester. Especially given the presence of those other denizens of preprocessor country, acceptMacro() and enterInclusion(). One obvious application of a robust CDT parser interface would be a JavaDoc-style documentation generator; the ability to pick up doc comments is central there, and I can't see how it would add significant processing overhead for interface implementors which didn't care about comments. Hover help popups in the editor could also benefit from extracted doc comments.


Cheers,
Mike


P.S. Yes, I have seen the various suggestions that Eclipse use Doxygen for doc generation, but I'm not convinced. While I've used Doxygen a lot and greatly appreciate the work Dmitri has put into it, I also feel that its architecture is too monolithic and too reliant on an ever-increasing rats'-nest of config options. Also, the frankly bizarre dependency on Qt even for the core command-line app is always going to be a portability headache. I suspect that using the CDT parser for input, vanilla XML as intermediate representation and XSLT/XSL-FO/Batik for output (maybe pinching some components from Eclipse GEF for class diagram layout), could cover 90% of the functionality required by a JavaDoc equivalent.





Back to the top