Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[cdt-dev] CDT API Docs for 8.4

Hi all,

 

A release is always a chance doing some necessary cleanups.

 

To that end, I have noticed that the CDT API Docs were in a bad shape:

https://bugs.eclipse.org/bugs/show_bug.cgi?id=435887

 

I have fixed version numbers, copyright dates and links to the online JDK API’s with a Gerrit submission

(not merged yet). But I also noticed that LOTS of public CDT API classes are not documented in the

HTML API Docs.

 

I was unsure whether that was intentional – some packages like org.eclipse.cdt.core.language

still carry an “EXPERIMENTAL” tag so should probably not be published as HTML API. Others

like org.eclipse.cdt.core.dom were really surprising to me since they seem to be mandatory

for anyone doing any work on the AST, which I have seen on the mailing list people actually do.

 

I thought that a mailing list discussion might be best to get some ideas if any additional CDT

API Packages should be published in the Javadocs at this point. Adding them is really easy

technically, but there needs to be consensus what should be added. The current status quo

is online here: http://help.eclipse.org/kepler/nav/13_1

 

Any thoughts / comments ?

 

Thanks,

Martin

--

Martin Oberhuber, SMTS / Product Owner – Development Tools, Wind River

direct +43.662.457915.85  fax +43.662.457915.6

 


Back to the top