Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [cdt-dev] How to get online help for my C API functions


To use help documentation extension you need to do two things:

1) Prepare documentation itself with description for each keyword in
your library.
2) Write help provider contributing to extension point
This help provider should search for description in your documentation
according to requested keyword.

See documentation in bugzilla entry 71240 for more information.


-----Original Message-----
From: cdt-dev-admin@xxxxxxxxxxx [mailto:cdt-dev-admin@xxxxxxxxxxx] On
Behalf Of Alain Magloire
Sent: Wednesday, March 02, 2005 7:39 AM
To: cdt-dev@xxxxxxxxxxx
Subject: Re: [cdt-dev] How to get online help for my C API functions

> This is a multi-part message in MIME format.
> ------_=_NextPart_001_01C51D78.596310B6
> Content-Type: text/plain;
> 	charset="iso-8859-1"
> Content-Transfer-Encoding: quoted-printable
> Hello folks,
> =20
> I want to provide online help for my self-written C / C++ libraries =
> similar to the infopops with Javadoc that Java programmers can get
when =
> they hover over a class or method identifier.
> For my C API I have the help files in the format of one html-file per
> function, the name of the file corresponding to the function name.
> Can anybody give me hints / pointers how I go about this?

The extension is :
  <extension point="org.eclipse.cdt.ui.CHelpProvider">

The class must implement ICHelpProvider.

cdt-dev mailing list

Back to the top