Fix doc markup

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@18489 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Adam Fedor 2004-01-27 04:54:59 +00:00
parent 173ec629ad
commit 1066f6326d
5 changed files with 30 additions and 12 deletions

View file

@ -1,3 +1,12 @@
2004-01-26 Adam Fedor <fedor@gnu.org>
* /Headers/Additions/GNUstepGUI/GSHbox.h: Fix doc markup.
* Headers/Additions/GNUstepGUI/GSTable.h: Idem.
* Source/NSApplication.m: Idem.
* Source/DocMakefile (GuiAdditions_AGSDOC_FILES):
Add GuiAdditions.gsdoc
2004-01-26 Fred Kiefer <FredKiefer@gmx.de>
* Source/NSPopUpButton.m (-setTitle:) Call

View file

@ -54,6 +54,7 @@
To initialize a GSHbox, you should always use -init
method. Don't use GSTable methods. The correct way to start
using a new GSHbox is simply:
</p>
<example>
hbox = [GSHbox new];
</example>
@ -74,9 +75,11 @@
contents. Usually, you simply add objects to the GSHbox, and let
it compute its size (this is the minimum size); you may get this
resulting size by
</p>
<example>
size = [yourHBox size];
</example>
<p>
for example, if the GSHbox is to be used as the content view of a window,
you may create the window exactly with this size.
</p>
@ -122,6 +125,7 @@
<p>
When the GSHbox is resized in the vertical direction (as a
consequence of user intervertion, for example), what happens is:
</p>
<list>
<item> if the new height is less than the minimum height of the GSHbox
(computed as the maximum of the minimum height of the added views), it
@ -244,6 +248,7 @@ enablingXResizing: (BOOL)aFlag;
By changing the autoresizingMask you may decide whether the space
should go to the view or to its vertical margins; this for example
lets you center vertically or flush up/down your view.
</p>
*/
-(void) addView: (NSView *)aView
enablingXResizing: (BOOL)aFlag

View file

@ -73,7 +73,7 @@
You should not force a GSTable in a size different from the one
it has automatically computed. The only acceptable, reasonable and
meaningful way of resizing a GSTable is through the appropriate
-resizeWithOldSuperviewSize: message when the GSTable is
[NSView-resizeWithOldSuperviewSize:] message when the GSTable is
in the view hierarchy.
</p>
<p>
@ -92,8 +92,9 @@
-sizeToFit.
</p>
<p>
When the GSTable receives a -resizeWithOldSuperviewSize:
When the GSTable receives a [NSView-resizeWithOldSuperviewSize:]
message, it automatically rearranges the views it contains:
</p>
<list>
<item>
If the new width or height is equal or less than the table's minimum
@ -149,7 +150,7 @@
the dimension of the prisoner plus its margins. Since the
GSTable manages directly the jails, each prisoner is managed
together with its margins. When the jail is resized, the prisoner
receives a -resizeWithOldSuperviewSize:, which makes it resize
receives a [NSView-resizeWithOldSuperviewSize:], which makes it resize
itself and its margins in the new jail size, according to its
autoresizingMask.
</p>
@ -281,18 +282,18 @@ margins. */
withXMargins: (float)xMargins
yMargins: (float)yMargins;
/** Put aView in the GSTabl}, using the specified margins.
/** <p>Put aView in the GSTable, using the specified margins.
The names for the margins are chosen as to be as close as possible to
the autoresizingMask convention. The margins are to be interpreted as
follows:
follows:</p>
<deflist>
<item> minXMargin </item>
<term> minXMargin </term>
<desc>Left Margin</desc>
<item> maxXMargin </item>
<term> maxXMargin </term>
<desc>Right Margin</desc>
<item> minYMargin </item>
<term> minYMargin </term>
<desc>Lower Margin (Upper if view is flipped)</desc>
<item> maxYMargin </item>
<term> maxYMargin </term>
<desc>Upper Margin (Lower if view is flipped)</desc>
</deflist>

View file

@ -153,7 +153,8 @@ Gui_AGSDOC_FILES = ../Documentation/Gui/Gui.gsdoc \
../Documentation/Gui/NSStringAdditions.gsdoc \
$(AUTOGSDOC_HEADERS_GUI)
GuiAdditions_AGSDOC_FILES = $(AUTOGSDOC_HEADERS_GUIADD)
GuiAdditions_AGSDOC_FILES = $(AUTOGSDOC_HEADERS_GUIADD) \
../Documentation/GuiAdditions/GuiAdditions.gsdoc
GuiUser_AGSDOC_FILES = \
../Documentation/Gui/DefaultsSummary.gsdoc \
@ -192,7 +193,7 @@ GuiAdditions_AGSDOC_FLAGS = \
-WordMap '{\
APPKIT_EXPORT=extern;APPKIT_DECLARE="";\
DEFINE_RINT_IF_MISSING=""; \
}' -Up Gui
}' -Up GuiAdditions
GuiUser_AGSDOC_FLAGS = \
-DocumentationDirectory ../Documentation/GuiUser \

View file

@ -1268,6 +1268,7 @@ whether it is still running or has been stopped, etc)
</p>
<p>If there are no pending events for the session, this method returns
immediately.
</p>
<p>
See Also: -runModalForWindow:
</p>
@ -2132,7 +2133,7 @@ image.
<term>Authors</term>
<desc> An array of strings, each one with the name
of an author (eg, <var>[NSArray arrayWithObject: "Nicola Pero
<n.peromi.flashnet.it>"]</var>). If not found,
&lt;n.peromi.flashnet.it&gt;"]</var>). If not found,
<file>Info-gnustep.plist</file> is searched for <var>Authors</var>,
if this fails, <var>"Unknown"</var> is displayed.
</desc>
@ -2161,6 +2162,7 @@ image.
<var>CopyrightDescription</var>. If this fails, no copyright
description is shown.
</desc>
</deflist>
*/
- (void) orderFrontStandardInfoPanelWithOptions: (NSDictionary *)dictionary
{