Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 260830 - [API] add @noextend and @noimplement tags
Summary: [API] add @noextend and @noimplement tags
Status: RESOLVED FIXED
Alias: None
Product: CDT
Classification: Tools
Component: cdt-core (show other bugs)
Version: 6.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 6.0   Edit
Assignee: Project Inbox CLA
QA Contact: Doug Schaefer CLA
URL:
Whiteboard:
Keywords:
Depends on: 301373
Blocks:
  Show dependency tree
 
Reported: 2009-01-13 05:30 EST by Markus Schorn CLA
Modified: 2010-02-17 14:42 EST (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Schorn CLA 2009-01-13 05:30:54 EST 
The javadoc tags for the api-tooling will be published in a .api_description file with the plugins. Therefore it is important to add @noimplement and @noextend tags to all interfaces/classes of the public API. See also my email on the dev list: http://dev.eclipse.org/mhonarc/lists/cdt-dev/msg14062.html

Here is the list of packages containing public API:


Plugin org.eclipse.cdt.core:
----------------------------
 org.eclipse.cdt.core,
 org.eclipse.cdt.core.browser,
 org.eclipse.cdt.core.cdtvariables,
 org.eclipse.cdt.core.dom,
 org.eclipse.cdt.core.dom.ast,
 org.eclipse.cdt.core.dom.ast.c,
 org.eclipse.cdt.core.dom.ast.cpp,
 org.eclipse.cdt.core.dom.ast.gnu,
 org.eclipse.cdt.core.dom.ast.gnu.c,
 org.eclipse.cdt.core.dom.ast.gnu.cpp,
 org.eclipse.cdt.core.dom.parser,
 org.eclipse.cdt.core.dom.parser.c,
 org.eclipse.cdt.core.dom.parser.cpp,
 org.eclipse.cdt.core.dom.rewrite,
 org.eclipse.cdt.core.envvar,
 org.eclipse.cdt.core.errorparsers,
 org.eclipse.cdt.core.formatter,
 org.eclipse.cdt.core.index,
 org.eclipse.cdt.core.index.export,
 org.eclipse.cdt.core.index.provider,
 org.eclipse.cdt.core.language,
 org.eclipse.cdt.core.model,
 org.eclipse.cdt.core.model.util,
 org.eclipse.cdt.core.parser,
 org.eclipse.cdt.core.parser.ast,
 org.eclipse.cdt.core.parser.util,
 org.eclipse.cdt.core.resources,
 org.eclipse.cdt.core.settings.model,
 org.eclipse.cdt.core.settings.model.extension,
 org.eclipse.cdt.core.settings.model.extension.impl,
 org.eclipse.cdt.core.settings.model.util,
 org.eclipse.cdt.core.templateengine,
 org.eclipse.cdt.core.templateengine.process,
 org.eclipse.cdt.core.templateengine.process.processes,
 org.eclipse.cdt.utils,
 org.eclipse.cdt.utils.cdtvariables,
 org.eclipse.cdt.utils.coff,
 org.eclipse.cdt.utils.coff.parser,
 org.eclipse.cdt.utils.debug,
 org.eclipse.cdt.utils.debug.dwarf,
 org.eclipse.cdt.utils.debug.stabs,
 org.eclipse.cdt.utils.debug.tools,
 org.eclipse.cdt.utils.elf,
 org.eclipse.cdt.utils.elf.parser,
 org.eclipse.cdt.utils.envvar,
 org.eclipse.cdt.utils.macho,
 org.eclipse.cdt.utils.macho.parser,
 org.eclipse.cdt.utils.pty,
 org.eclipse.cdt.utils.som,
 org.eclipse.cdt.utils.som.parser,
 org.eclipse.cdt.utils.spawner,
 org.eclipse.cdt.utils.xcoff,
 org.eclipse.cdt.utils.xcoff.parser

Plugin org.eclipse.cdt.ui:
==========================
 org.eclipse.cdt.ui,
 org.eclipse.cdt.ui.actions,
 org.eclipse.cdt.ui.browser.typeinfo,
 org.eclipse.cdt.ui.dialogs,
 org.eclipse.cdt.ui.internal.templateengine.wizard;x-internal:=true,
 org.eclipse.cdt.ui.newui,
 org.eclipse.cdt.ui.refactoring,
 org.eclipse.cdt.ui.refactoring.actions,
 org.eclipse.cdt.ui.templateengine,
 org.eclipse.cdt.ui.templateengine.event,
 org.eclipse.cdt.ui.templateengine.pages,
 org.eclipse.cdt.ui.templateengine.uitree,
 org.eclipse.cdt.ui.templateengine.uitree.uiwidgets,
 org.eclipse.cdt.ui.text,
 org.eclipse.cdt.ui.text.c.hover,
 org.eclipse.cdt.ui.text.contentassist,
 org.eclipse.cdt.ui.text.doctools,
 org.eclipse.cdt.ui.text.doctools.doxygen,
 org.eclipse.cdt.ui.text.doctools.generic,
 org.eclipse.cdt.ui.text.folding,
 org.eclipse.cdt.ui.wizards,
 org.eclipse.cdt.ui.wizards.conversion,
 org.eclipse.cdt.utils.ui.controls
Comment 1 Anton Leherbauer CLA 2009-02-03 08:48:57 EST 
I have added tags where necessary/appropriate for most of the public packages in the UI plug-in, except for the template engine packages:

 org.eclipse.cdt.ui.templateengine,
 org.eclipse.cdt.ui.templateengine.event,
 org.eclipse.cdt.ui.templateengine.pages,
 org.eclipse.cdt.ui.templateengine.uitree,
 org.eclipse.cdt.ui.templateengine.uitree.uiwidgets,
Comment 2 Chris Recoskie CLA 2009-02-03 12:34:00 EST 
The removal of the deprectated API ICompletionContributor is causing API tooling errors.
Comment 3 Anton Leherbauer CLA 2009-02-04 02:47:13 EST 
(In reply to comment #2)
> The removal of the deprectated API ICompletionContributor is causing API
> tooling errors.

Sorry, I was too hasty. I have restored the interface.
Comment 4 Markus Schorn CLA 2009-02-04 06:22:59 EST 
I have looked at the core-plugin exept a few packages. With Toni's work that leaves us with the following packages to look at:

Plugin org.eclipse.cdt.core:
============================
 org.eclipse.cdt.core.settings.model,
 org.eclipse.cdt.core.settings.model.extension,
 org.eclipse.cdt.core.settings.model.extension.impl,
 org.eclipse.cdt.core.settings.model.util,
 org.eclipse.cdt.core.templateengine,
 org.eclipse.cdt.core.templateengine.process,
 org.eclipse.cdt.core.templateengine.process.processes,
 org.eclipse.cdt.utils.debug,
 org.eclipse.cdt.utils.debug.dwarf,
 org.eclipse.cdt.utils.debug.stabs,
 org.eclipse.cdt.utils.debug.tools

Plugin org.eclipse.cdt.ui:
==========================
 org.eclipse.cdt.ui.templateengine,
 org.eclipse.cdt.ui.templateengine.event,
 org.eclipse.cdt.ui.templateengine.pages,
 org.eclipse.cdt.ui.templateengine.uitree,
 org.eclipse.cdt.ui.templateengine.uitree.uiwidgets
Comment 5 Markus Schorn CLA 2009-06-17 03:25:05 EDT 
game over.