Merge pull request #360 from gnustep/documentation_changes

Add missing documentation

Author: gcasa

Headers/Additions/GNUstepGUI/GSAnimator.h

@@ -1,28 +1,50 @@
-/*
-   GSAnimator.h
- 
-   Author: Xavier Glattard (xgl) <[email protected]>
- 
-   Copyright (c) 2007 Free Software Foundation, Inc.
- 
-   This file is part of the GNUstep GUI Library.
- 
-   This library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-
-   This library is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
-   Lesser General Public License for more details.
-
-   You should have received a copy of the GNU Lesser General Public
-   License along with this library; see the file COPYING.LIB.
-   If not, see <http://www.gnu.org/licenses/> or write to the 
-   Free Software Foundation, 51 Franklin Street, Fifth Floor, 
-   Boston, MA 02110-1301, USA.
- */ 
+/** <title>GSAnimator</title>
+
+    <abstract>Animation timing and coordination system for GNUstep GUI</abstract>
+
+    GSAnimator provides a framework for creating smooth animations and timed
+    visual effects in GNUstep applications. It manages the timing, coordination,
+    and execution of multiple concurrent animations while providing a simple
+    interface for developers to create engaging user interface animations.
+
+    The animator system supports:
+    * Multiple concurrent animations with independent timing
+    * Easing functions for natural motion curves
+    * Animation grouping and sequencing
+    * Automatic frame rate management and optimization
+    * Event-driven animation control and callbacks
+
+    GSAnimator integrates with the AppKit drawing system to provide efficient
+    animation rendering while maintaining responsive user interaction. It can
+    animate any property that affects the visual presentation of views,
+    including position, size, opacity, rotation, and custom properties.
+
+    This class serves as the foundation for higher-level animation APIs and
+    provides the infrastructure needed for creating sophisticated animated
+    user interfaces in GNUstep applications.
+
+    Author: Xavier Glattard (xgl) <[email protected]>
+
+    Copyright (c) 2007 Free Software Foundation, Inc.
+
+    This file is part of the GNUstep GUI Library.
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; see the file COPYING.LIB.
+    If not, see <http://www.gnu.org/licenses/> or write to the
+    Free Software Foundation, 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
 
 #ifndef _GNUstep_H_GSAnimator_
 #define _GNUstep_H_GSAnimator_
@@ -53,7 +75,7 @@
 @end
 
 /**
- * GSAnimator is the front of a class cluster. Instances of a subclass of 
+ * GSAnimator is the front of a class cluster. Instances of a subclass of
  * GSAnimator manage the timing of an animation.
  */
 APPKIT_EXPORT_CLASS
@@ -67,7 +89,7 @@ APPKIT_EXPORT_CLASS
   unsigned int _frameCount;   // The number of loops since the start
 
   NSArray *_runLoopModes;
-  
+
   NSTimer *_timer;            // Timer used for looping
   NSTimeInterval _timerInterval;
 }
@@ -81,7 +103,7 @@ APPKIT_EXPORT_CLASS
 + (GSAnimator*) animatorWithAnimation: (id<GSAnimation>)anAnimation
                             frameRate: (float)fps;
 
-/** Returns a GSAnimator object allocated in the given NSZone and 
+/** Returns a GSAnimator object allocated in the given NSZone and
  * initialized with the specified object to be animated. */
 + (GSAnimator*) animatorWithAnimation: (id<GSAnimation>)anAnimation
                             frameRate: (float)fps

Headers/Additions/GNUstepGUI/GSCharacterPanel.h

@@ -1,31 +1,52 @@
-/* 
-   GSCharacterPanel.h
-
-   Ghostscript image representation.
-
-   Copyright (C) 2011 Free Software Foundation, Inc.
-
-   Written by:  Eric Wasylishen <[email protected]>
-   Date: June 2011
-   
-   This file is part of the GNUstep GUI Library.
-
-   This library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-
-   This library is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
-   Lesser General Public License for more details.
-
-   You should have received a copy of the GNU Lesser General Public
-   License along with this library; see the file COPYING.LIB.
-   If not, see <http://www.gnu.org/licenses/> or write to the 
-   Free Software Foundation, 51 Franklin Street, Fifth Floor, 
-   Boston, MA 02110-1301, USA.
-*/ 
+/** <title>GSCharacterPanel</title>
+
+    <abstract>Character palette panel for text input and Unicode character selection</abstract>
+
+    GSCharacterPanel provides a user interface for browsing and selecting
+    Unicode characters, special symbols, and text input methods. It serves
+    as a character palette that allows users to insert characters that may
+    not be easily accessible through their keyboard layout.
+
+    The character panel features:
+    * Unicode character browsing by category and script
+    * Search functionality for finding specific characters
+    * Recent and favorite character collections
+    * Character information display including Unicode details
+    * Integration with text input systems and text views
+
+    This panel is particularly useful for:
+    * Inserting symbols, mathematical characters, and special punctuation
+    * Working with multilingual text and international scripts
+    * Accessing extended character sets not available on the keyboard
+    * Educational and reference purposes for Unicode exploration
+
+    The GSCharacterPanel integrates with the standard AppKit text input
+    system and can insert selected characters into any text-accepting
+    control or view that supports text input.
+
+    Copyright (C) 2011 Free Software Foundation, Inc.
+
+    Written by:  Eric Wasylishen <[email protected]>
+    Date: June 2011
+
+    This file is part of the GNUstep GUI Library.
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; see the file COPYING.LIB.
+    If not, see <http://www.gnu.org/licenses/> or write to the
+    Free Software Foundation, 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
 
 #ifndef _GNUstep_H_GSCharacterPanel
 #define _GNUstep_H_GSCharacterPanel

Headers/Additions/GNUstepGUI/GSToolbarView.h

@@ -1,15 +1,15 @@
-/* 
-   <title>GSToolbarView.h</title>
+/*
+   <title>GSToolbarView</title>
 
    <abstract>The private toolbar class which draws the actual toolbar.</abstract>
-   
+
    Copyright (C) 2002 Free Software Foundation, Inc.
 
    Author:  Gregory John Casamento <[email protected]>,
             Fabien Vallon <[email protected]>,
 	    Quentin Mathe <[email protected]>
    Date: May 2002
-   
+
    This file is part of the GNUstep GUI Library.
 
    This library is free software; you can redistribute it and/or
@@ -24,10 +24,10 @@
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; see the file COPYING.LIB.
-   If not, see <http://www.gnu.org/licenses/> or write to the 
-   Free Software Foundation, 51 Franklin Street, Fifth Floor, 
+   If not, see <http://www.gnu.org/licenses/> or write to the
+   Free Software Foundation, 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
-*/ 
+*/
 
 #ifndef _GSToolbarView_h_INCLUDE
 #define _GSToolbarView_h_INCLUDE

Headers/Additions/GNUstepGUI/GSXibKeyedUnarchiver.h

@@ -1,36 +1,36 @@
-/** <title>GSXibKeyedUnarchiver.h</title>
- 
+/** <title>GSXibKeyedUnarchiver</title>
+
  <abstract>
  These are templates for use with OSX XIB 5 files.  These classes are the
  templates and other things which are needed for reading XIB 5 files.
  </abstract>
- 
+
  Copyright (C) 2005,2017 Free Software Foundation, Inc.
- 
+
  File created by Marcian Lytwyn on 12/30/16 from original code by:
- 
+
  Author: Gregory John Casamento
  Date: 2003, 2005
- 
+
  This file is part of the GNUstep GUI Library.
- 
+
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.
- 
+
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
  Lesser General Public License for more details.
- 
+
  You should have received a copy of the GNU Lesser General Public
  License along with this library; see the file COPYING.LIB.
  If not, see <http://www.gnu.org/licenses/> or write to the
  Free Software Foundation, 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
  */
- 
+
 #import <AppKit/AppKitDefines.h>
 #import <Foundation/Foundation.h>
 

Headers/AppKit/AppKitDefines.h

@@ -1,27 +1,39 @@
-/* Plateform specific definitions for externs
-   Copyright (C) 2001 Free Software Foundation, Inc.
-
-   Written by:  Adam Fedor <[email protected]>
-   Date: Jul, 2001
-   
-   This file is part of the GNUstep GUI Library.
-
-   This library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Lesser General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-
-   This library is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
-   Lesser General Public License for more details.
-
-   You should have received a copy of the GNU Lesser General Public
-   License along with this library; see the file COPYING.LIB.
-   If not, see <http://www.gnu.org/licenses/> or write to the 
-   Free Software Foundation, 51 Franklin Street, Fifth Floor, 
-   Boston, MA 02110-1301, USA.
-*/ 
+/** <title>AppKitDefines</title>
+
+    <abstract>Platform-specific definitions and export macros for AppKit</abstract>
+
+    This header provides platform-specific macro definitions for symbol
+    export/import declarations across different operating systems and
+    compilers. It defines the APPKIT_EXPORT, APPKIT_IMPORT, and related
+    macros that control symbol visibility and linkage in the AppKit library.
+
+    The macros handle differences between Windows DLL builds, Unix shared
+    library builds, and static library configurations, ensuring proper
+    symbol visibility across all supported platforms.
+
+    Copyright (C) 2001 Free Software Foundation, Inc.
+
+    Written by:  Adam Fedor <[email protected]>
+    Date: Jul, 2001
+
+    This file is part of the GNUstep GUI Library.
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; see the file COPYING.LIB.
+    If not, see <http://www.gnu.org/licenses/> or write to the
+    Free Software Foundation, 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
 
 #ifndef __AppKitDefines_INCLUDE
 #define __AppKitDefines_INCLUDE
@@ -33,7 +45,7 @@
 #define APPKIT_EXTERN extern
 #endif
 
-#ifdef GNUSTEP_WITH_DLL 
+#ifdef GNUSTEP_WITH_DLL
 
 #if BUILD_libgnustep_gui_DLL