Eclipse Community Forums: C / C++ IDE (CDT)

Home » Language IDEs » C / C++ IDE (CDT) » CDT Help system

CDT Help system [message #201857]

Tue, 18 September 2007 08:25

Eclipse User

Originally posted by: pelle2004.gmail.com

Hi,

I like to know what the full capacity of Eclipse when it comes to the help
system.

For instance I would like to have the opportunity in the CDT-Editor to
mark a glibc
function and hit F1/Help and end up in the explanation of that function.

...
const struct timeval tp,tzp;
settimeofday (&tp, &tzp);
...

Just mark or stand above 'settimeofday' and hit help should end up in a
glibc-section
inside the local help system. Contents of that should be a copy of
' http://www.gnu.org/software/libc/manual/html_mono/libc.html# High_002dResolution-Calendar'

So my question are...

- Is it already possible
- Where can I find information, web-links...
- Is there any help project/plug-ins, web-links...
- If not any extension points for a plug-in.

/Pelle

Re: CDT Help system [message #201884 is a reply to message #201857]

Wed, 19 September 2007 03:42

Eclipse User

Pelle Svensson wrote:
>
> Hi,
>
> I like to know what the full capacity of Eclipse when it comes to the
> help system.
>
> For instance I would like to have the opportunity in the CDT-Editor to
> mark a glibc
> function and hit F1/Help and end up in the explanation of that function.
>
>
> ...
> const struct timeval tp,tzp;
> settimeofday (&tp, &tzp);
> ...
>
> Just mark or stand above 'settimeofday' and hit help should end up in a
> glibc-section
> inside the local help system. Contents of that should be a copy of
> ' http://www.gnu.org/software/libc/manual/html_mono/libc.html# High_002dResolution-Calendar'
>
>
> So my question are...
>
> - Is it already possible
> - Where can I find information, web-links...
> - Is there any help project/plug-ins, web-links...
> - If not any extension points for a plug-in.
>
>
> /Pelle

It is possible if you extend the "org.eclipse.cdt.ui.CHelpProvider"
extension point and implement the interface ICHelpProvider which
provides documentation and links for a particular function.
Basically it burns down to creating a mapping between function name and
documentation/links and some Java code to lookup the data.

--
Anton Leherbauer
Wind River CDT Team, Austria

Re: CDT Help system [message #202040 is a reply to message #201884]

Mon, 24 September 2007 04:50

Eclipse User

Originally posted by: pelle2004.gmail.com

On Wed, 19 Sep 2007 09:42:20 +0200, Anton Leherbauer
<anton.leherbauer@windriver.com> wrote:

> Pelle Svensson wrote:
>> Hi,
>> I like to know what the full capacity of Eclipse when it comes to the
>> help system.
>> For instance I would like to have the opportunity in the CDT-Editor to
>> mark a glibc
>> function and hit F1/Help and end up in the explanation of that function.
>> ...
>> const struct timeval tp,tzp;
>> settimeofday (&tp, &tzp);
>> ...
>> Just mark or stand above 'settimeofday' and hit help should end up in
>> a glibc-section
>> inside the local help system. Contents of that should be a copy of
>> ' http://www.gnu.org/software/libc/manual/html_mono/libc.html# High_002dResolution-Calendar'
>> So my question are...
>> - Is it already possible
>> - Where can I find information, web-links...
>> - Is there any help project/plug-ins, web-links...
>> - If not any extension points for a plug-in.
>> /Pelle
>
> It is possible if you extend the "org.eclipse.cdt.ui.CHelpProvider"
> extension point and implement the interface ICHelpProvider which
> provides documentation and links for a particular function.
> Basically it burns down to creating a mapping between function name and
> documentation/links and some Java code to lookup the data.
>

Ok,

Other question is if there are glibc and cpp/stl sections inside Eclipse's
help.
Has any-one converted GNU's help to Eclipse format?

--
Using Opera's revolutionary e-mail client: http://www.opera.com/mail/

Re: CDT Help system [message #202107 is a reply to message #202040]

Tue, 25 September 2007 14:21

Eclipse User

> Ok,
>
> Other question is if there are glibc and cpp/stl sections inside
> Eclipse's help.
> Has any-one converted GNU's help to Eclipse format?
>

We can't do this because the GNU man pages and other documentation are
GPL licensed, which is not compatible with the EPL license we use at
Eclipse.org

===========================

Chris Recoskie
Team Lead, IBM CDT Team
IBM Toronto
http://www.eclipse.org/cdt

Re: CDT Help system [message #202204 is a reply to message #202107]

Wed, 26 September 2007 04:50

Eclipse User

Originally posted by: paul.mcconkey.net

> We can't do this because the GNU man pages and other documentation are GPL
> licensed, which is not compatible with the EPL license we use at
> Eclipse.org

Presumably the license incompatibility just means that Eclipse.org wouldn't
be able to distribute the Eclipsified man pages. It would be fine for
someone to make a GPL version of the man pages and to distribute them for
others to use.

I'd use them for sure.

Cheers,

Paul.

Re: CDT Help system [message #202213 is a reply to message #202204]

Wed, 26 September 2007 09:36

Eclipse User

Paul McConkey wrote:
>> We can't do this because the GNU man pages and other documentation are GPL
>> licensed, which is not compatible with the EPL license we use at
>> Eclipse.org
>
> Presumably the license incompatibility just means that Eclipse.org wouldn't
> be able to distribute the Eclipsified man pages. It would be fine for
> someone to make a GPL version of the man pages and to distribute them for
> others to use.
>
> I'd use them for sure.
>
> Cheers,
>
> Paul.
>
>

Yes... someone could do a Sourcforge project or whatever. It's
definitely a useful feature and it would get wide usage. Maybe someone
could contribute this to Redhat or one of the other Linux distros that
are bundling CDT.

===========================

Chris Recoskie
Team Lead, IBM CDT Team
IBM Toronto
http://www.eclipse.org/cdt

Previous Topic:	Usage of External Settings Provider Extension
Next Topic:	Removing project from Build All command

Goto Forum:

-=] Back to Top [=-

Current Time: Fri Jul 18 06:15:51 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter