RE: [cdt-dev] C++ Documentation

[justinsea@xxxxxxxxxxxxx]

Hi Norbert,

In a posting earlier, you mentioned you have contributed to the C Help Book ("org.eclipse.cdt.ui.CHelpProvider") extension point in order to provide content assist for a C API. I essentially implemented along the same lines, but am having some issues.

First, CDT provides its own content assist in addition to my contribution. Do you know if there is a way to suppress the CDT suggestion? E.g., for a function like "int myFunction(int, int)", I now see two suggestions after hitting Ctrl-space, one provided by CDT and one provided by my own C Help Book contribution.

Second, does your C Help Book contribution work for parameter editing? That is, if one is typing "myFunction(," in editor, first parameter should get bold color in the small, yellow code completion window to highlight the type of the first parameter. When one finishes typing the first parameter, the second parameter type should get bold color, etc.

Any ideas? 

Thanks in advance for your help.

Justin

----------------------------------------------------------------------------------------
    * From: "Ploett Norbert" <norbert.ploett@xxxxxxxxxxx>
    * Date: Thu, 14 Jul 2005 07:43:18 +0200
    * Delivered-to: cdt-dev@xxxxxxxxxxx
    * Thread-index: AcWHwOn1rFRvGosXSLai3UvFjwGxMAAdPNwg
    * Thread-topic: [cdt-dev] C++ Documentation

Hari,

we did something along these lines by contributing a self-written help provider to the org.eclipse.cdt.ui.CHelpProvider extension point. When you implement all the methods of the required org.eclipse.cdt.ui.ICHelpProvider interface you get called for F1-events, hover help and content assist calls. 

The solution is non-standard however because your help provider must go back to some database in order to return the information required by the interface and since there is no standard about how to represent those data there can be no standard implementation for the help provider.

In our case we had documentation for a company-proprietary C API, it was flat, one html file per function and the file name identical to the function name. 

Let me know if you do file an enhancement request, I would be interested to contribute to developping a representation standard which can cover many (if not all) application cases.

Regards,

Norbert