Bug 184937 - [69cat] Incomplete NetBeans API Javadoc Package Descriptions
[69cat] Incomplete NetBeans API Javadoc Package Descriptions
Status: NEW
Product: platform
Classification: Unclassified
Component: -- Other --
7.0.1
PC Windows Vista
: P3 (vote)
: TBD
Assigned To: issues@platform
issues@platform
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2010-04-26 02:35 UTC by gliesian
Modified: 2011-11-04 18:22 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
:


Attachments
Missing Text - THIS IS THE WRONG IMAGE, PLEASE IGNORE (26.58 KB, image/jpeg)
2010-04-26 02:46 UTC, gliesian
Details
Nodes API - Missing Text (145.04 KB, image/jpeg)
2010-04-26 02:50 UTC, gliesian
Details

Note You need to log in before you can comment on or make changes to this bug.
Description gliesian 2010-04-26 02:35:22 UTC
While the majority of NetBeans API packages have descriptions associated with them, many do not.  For example, the Node API has two packages with description, and one without any: 

Nodes API
org.openide.cookies 	 Cookies are a design pattern used...
org.openide.nodes 	 NetBeans uses nodes to represent JavaBeans...
org.openide.util.actions << No DESCRIPTION >>


The following is a list of packages associated with "Content" links on this URL (http://bits.netbeans.org/dev/javadoc/index.html) that do not have Javadoc descriptions:

Common Palette
Packages: org.netbeans.spi.palette

Core - IDE 
org.netbeans.api.core.ide

Database Explorer
org.netbeans.api.db.explorer 	 
org.netbeans.api.db.explorer.node 	 
org.netbeans.api.db.explorer.support 	 
org.netbeans.api.db.sql.support 	 
org.netbeans.spi.db.explorer

DataSystems API
org.openide.actions 	 
org.openide.awt 	 
org.openide.text

Diff
org.netbeans.api.diff 	 
org.netbeans.spi.diff

Editor Code Copmletion
org.netbeans.api.editor.completion 	 
org.netbeans.spi.editor.completion 	 
org.netbeans.spi.editor.completion.support

Editor Code Folding
org.netbeans.api.editor.fold 	 
org.netbeans.spi.editor.fold 	 

Editor Code Templates
org.netbeans.lib.editor.codetemplates.api 	 
org.netbeans.lib.editor.codetemplates.spi 	 

Editor Error Stripe

Editor Guarded Sections
org.netbeans.api.editor.guards 	 
org.netbeans.spi.editor.guards 	 
org.netbeans.spi.editor.guards.support 	 

Editor Library 2
org.netbeans.api.editor

Editor Settings
org.netbeans.api.editor.settings 

Explorer & Properties Sheet API
org.openide.explorer.propertysheet.editors 	

External Libraries
org.netbeans.spi.project.libraries 	 
org.netbeans.spi.project.libraries.support

General Queries API
org.netbeans.api.fileinfo 	  

Java Project Support
org.netbeans.api.java.project 	 
org.netbeans.api.java.project.classpath 	 
org.netbeans.api.java.project.runner 	 
org.netbeans.spi.java.project.classpath 	 
org.netbeans.spi.java.project.classpath.support 	 
org.netbeans.spi.java.project.runner 	 
org.netbeans.spi.java.project.support 	 
org.netbeans.spi.java.project.support.ui.templates 	 

Java Source
org.netbeans.api.java.loaders 	 
org.netbeans.api.java.source.support 	 
org.netbeans.spi.java.loaders 	 	 

Java Source UI
org.netbeans.api.java.source.ui 	 

Java Support APIs
org.netbeans.api.java.classpath 	

JPDA Debugger API
org.netbeans.api.debugger.jpda.event 	  

MIME Lookup API
org.netbeans.api.editor.mimelookup 	 

Nodes API
org.openide.util.actions 	 

Options Dialog and SPI
org.netbeans.api.options 	 
org.netbeans.spi.options 	 

Print
org.netbeans.api.print 	 
org.netbeans.spi.print 	 

Project API
org.netbeans.spi.project.support 	 

Quick Search API
org.netbeans.spi.quicksearch

Text API
org.openide.cookies 	  	 

Java Common Project API
org.netbeans.modules.java.api.common 	 
org.netbeans.modules.java.api.common.ant 	 
org.netbeans.modules.java.api.common.classpath 	 
org.netbeans.modules.java.api.common.project 	 
org.netbeans.modules.java.api.common.project.ui 	 
org.netbeans.modules.java.api.common.project.ui.customizer 	 
org.netbeans.modules.java.api.common.project.ui.wizards 	 
org.netbeans.modules.java.api.common.queries 	 
org.netbeans.modules.java.api.common.ui 	 
org.netbeans.modules.java.api.common.util

Keyring API
org.netbeans.spi.keyring 	

Please add package descriptions for the above packages into the Javadoc documentation.

Thanks!
Comment 1 gliesian 2010-04-26 02:46:26 UTC
Created attachment 97985 [details]
Missing Text - THIS IS THE WRONG IMAGE, PLEASE IGNORE

For clarity... image of missing Javadoc text
Comment 2 gliesian 2010-04-26 02:50:25 UTC
Created attachment 97986 [details]
Nodes API - Missing Text

Example: Nodes API - Missing Text
Comment 3 Peter Pis 2010-04-26 07:04:26 UTC
Could you please evaluate and reassign further?


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo