Added documentation. Refined fix to GSNibTemplates.m concerning memory leak. More improvements to follow. GJC

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@18281 72102866-910b-0410-8b05-ffd578937521

Headers/AppKit/NSMenuItem.h

@@ -44,50 +44,280 @@
  */
 @protocol NSMenuItem <NSCopying, NSCoding, NSObject>
 
+/**
+   <p> Returns a seperator.   This is just a blank menu item which serves 
+   to divide the menu into seperate parts.
+   </p>
+ */
 + (id<NSMenuItem>) separatorItem;
+
+/**
+   <p> 
+   Sets a flag that, when set to <code>YES</code>, objects of this class will use user defined key equivalents.
+   </p>
+ */
 + (void) setUsesUserKeyEquivalents: (BOOL)flag;
+
+/**
+   <p> Returns a flag which indicates if the receiver will use user defined 
+   key equivalents.
+   </p>
+ */
 + (BOOL) usesUserKeyEquivalents;
 
+/**
+   <p>
+   Returns the action of the receiver.
+   </p>
+ */
 - (SEL) action;
+
+/**
+   <p>
+   Returns a boolean indicating if the receiver has a sub menu.
+   </p>
+ */
 - (BOOL) hasSubmenu;
+
+/**
+   <p>
+   Returns the image to be displayed in the receiver.
+   </p>
+ */
 - (NSImage*) image;
+
+/**
+   <p>
+   Initializes the receiver with <var>aString</var> as the title.
+   The method called with the menu is selected is represented by <var>aSelector</var>.
+   The key equivalent which can be used to invoke this menu item is represented by
+   <var>charCode</var>.
+   </p>
+ */
 - (id) initWithTitle: (NSString*)aString
 	      action: (SEL)aSelector
        keyEquivalent: (NSString*)charCode;
+
+/**
+   <p>
+   Returns <code>YES</code> if the receiver is enabled.
+   </p>
+ */
 - (BOOL) isEnabled;
+
+/**
+   <p>
+   Returns a boolean indicating if the receiver is a separator.
+   </p>
+ */
 - (BOOL) isSeparatorItem;
+
+/**
+   <p>
+   Returns the key equivalent of the receiver.
+   </p>
+ */
 - (NSString*) keyEquivalent;
+
+/**
+   <p>
+   Returns the key equivalent mask.
+   </p>
+ */
 - (unsigned int) keyEquivalentModifierMask;
+
+/**
+   <p>
+   Returns the menu to which this menu item is connected.
+   </p>
+ */
 - (NSMenu*) menu;
+
+/**
+   <p>
+   Returns the image to be displayed when the receiver is in the "Mixed" state.
+   </p>
+ */
 - (NSImage*) mixedStateImage;
 - (NSString*) mnemonic;
 - (unsigned) mnemonicLocation;
+
+/**
+   <p>
+   Returns the image to be displayed when the receiver is in the "Off" state.
+   </p>
+ */
 - (NSImage*) offStateImage;
+
+/**
+   <p>
+   Returns the image to be displayed when the receiver is in the "On" state.
+   </p>
+ */
 - (NSImage*) onStateImage;
+
+/**
+   <p>
+   Returns the object represented by the reciever.
+   </p>
+ */
 - (id) representedObject;
+
+/**
+   <p>
+   Sets the action as <var>aSelector</var> on the receiver.
+   </p>
+ */
 - (void) setAction: (SEL)aSelector;
+
+/**
+   <p>
+   Set the receiver to be enabled.
+   </p>
+ */
 - (void) setEnabled: (BOOL)flag;
+
+/**
+   <p>
+   Sets the image to be displayed in the receiver.
+   </p>
+ */
 - (void) setImage: (NSImage*)menuImage;
+
+/**
+   <p>
+   Sets the key equivalent of the receiver.
+   </p>
+ */
 - (void) setKeyEquivalent: (NSString*)aKeyEquivalent;
+
+/**
+   <p>
+   Sets the modfier for the key equivalent.   These masks indicate if the
+   key equivalent requires ALT, Control or other key modifiers.
+   </p>
+ */
 - (void) setKeyEquivalentModifierMask: (unsigned int)mask;
+
+/**
+   <p> Sets the menu which this item belongs to.   This method does not retain the
+   object represented by <var>menu</var>.
+   </p>
+ */
 - (void) setMenu: (NSMenu*)menu;
+
+/**
+   <p>
+   Sets the image to be displayed when the receiver is in the "Mixed" state.
+   </p>
+ */
 - (void) setMixedStateImage: (NSImage*)image;
 - (void) setMnemonicLocation: (unsigned) location;
+
+/**
+   <p>
+   Sets the image to be displayed when the receiver is in the "Off" state.
+   </p>
+ */
 - (void) setOffStateImage: (NSImage*)image;
+
+/**
+   <p>
+   Sets the image to be displayed when the receiver is in the "On" state.
+   </p>
+ */
 - (void) setOnStateImage: (NSImage*)image;
+
+/**
+   <p>
+   Sets the object represented by the reciever to <var>anObject</var>.
+   </p>
+ */
 - (void) setRepresentedObject: (id)anObject;
+
+/**
+   <p>
+   Sets the state of the the receiver.
+   </p>
+ */
 - (void) setState: (int)state;
+
+/**
+   <p>
+   Sets the submenu of the receiver.  This method does retain the 
+   <var>submenu</var> object.
+   </p>
+ */
 - (void) setSubmenu: (NSMenu*)submenu;
+
+/**
+   <p>
+   Sets the tag of the reciever as <var>anInt</var>.
+   </p>
+ */
 - (void) setTag: (int)anInt;
+
+/**
+   <p>
+   Sets the target as <var>anObject</var> on the receiver.
+   </p>
+ */
 - (void) setTarget: (id)anObject;
+
+/**
+   <p>
+   Sets the title of the menu, represented by <var>aString</var>.
+   </p>
+ */
 - (void) setTitle: (NSString*)aString;
 - (void) setTitleWithMnemonic: (NSString*)stringWithAmpersand;
+
+/**
+   <p>
+   Returns the state of the receiver.
+   </p>
+ */
 - (int) state;
+/**
+   <p>
+   Returns the attached submenu.
+   </p>
+ */
 - (NSMenu*) submenu;
+
+/**
+   <p>
+   Returns the tag of the receiver.
+   </p>
+ */
 - (int) tag;
+
+/**
+   <p>
+   Returns the target of the receiver.
+   </p>
+ */
 - (id) target;
+
+/**
+   <p>
+   Returns the menu's title.
+   </p>
+ */
 - (NSString*) title;
+
+/**
+   <p>
+   Returns the user defined key equivalent modifier.
+   </p>
+ */
 - (unsigned int) userKeyEquivalentModifierMask;
+
+/**
+   <p>
+   Returns the key equivalent defined by the users defaults.
+   </p>
+ */
 - (NSString*) userKeyEquivalent;
 
 @end