Update documentation building

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@14749 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2002-10-13 06:17:04 +00:00
parent 7ae86bf2f5
commit e23391c4e5
5 changed files with 204 additions and 45 deletions

View file

@ -9,6 +9,10 @@
* Source/NSSavePanel.m: ([--browser:createRowsForColumn:inMatrix:])
Don't try to read .hidden file for processing unless it exists.
* Source/DocMakefile: New makefile for building documentation
without having to build binaries. Also add flag for macros template.
* Source/GNUmakefile: Removed documentation building rules.
* Documentation/GNUmakefile: Use DocMakefile
2002-10-11 Adam Fedor <fedor@gnu.org>

View file

@ -64,6 +64,11 @@ BUGS_TEXI_FILES = version.texi
BUGS_TEXT_MAIN = todo.texi
BUGS_DOC_INSTALL_DIR = Developer/Gui/ReleaseNotes/$(VERSION)
#
# NB. Library reference documentation is generated by rules in the postamble
# file using the make file ../Source/DocMakefile. If headers are added to the
# library, you need to modify that file to get the autogsdoc tool to use them.
#
REF_DOC_INSTALL_DIR = $(GNUSTEP_INSTALLATION_DIR)/Documentation/Developer/Gui/Reference
-include GNUmakefile.preamble

View file

@ -29,7 +29,7 @@
# in the source directory to generate library reference documentation from
# the source code.
after-all::
$(MAKE) -C ../Source doc=yes
$(MAKE) -C ../Source -f DocMakefile
$(MAKE) -C Gui
# Things to do before installing

175
Source/DocMakefile Normal file
View file

@ -0,0 +1,175 @@
#
# Makefile for GNUstep Base Library documentation.
#
# Copyright (C) 2002 Free Software Foundation, Inc.
#
# Written by: Richard Frith-Macdonald <rfm.gnu.org>
#
# This file is part of the GNUstep Base Library.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library 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
# Library General Public License for more details.
#
# You should have received a copy of the GNU Library General Public
# License along with this library; if not, write to the Free
# Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
#
MAKEFILE_NAME = DocMakefile
GNUSTEP_MAKEFILES = $(GNUSTEP_SYSTEM_ROOT)/Makefiles
include $(GNUSTEP_MAKEFILES)/common.make
# These are gui headers that are also classes documented with autogsdoc
AUTOGSDOC_HEADERS = \
GSDisplayServer.h \
GSFusedSilica.h \
GSTable.h \
GSHbox.h \
GSVbox.h \
NSActionCell.h \
NSAffineTransform.h \
NSApplication.h \
NSBezierPath.h \
NSBox.h \
NSBitmapImageRep.h \
NSBrowser.h \
NSBrowserCell.h \
NSButton.h \
NSButtonCell.h \
NSCachedImageRep.h \
NSCell.h \
NSClipView.h \
NSColor.h \
NSColorList.h \
NSColorPanel.h \
NSColorPicker.h \
NSColorWell.h \
NSComboBox.h \
NSComboBoxCell.h \
NSControl.h \
NSCursor.h \
NSCustomImageRep.h \
NSDataLink.h \
NSDataLinkManager.h \
NSDataLinkPanel.h \
NSDocument.h \
NSDocumentController.h \
NSDrawer.h \
NSEPSImageRep.h \
NSEvent.h \
NSFileWrapper.h \
NSFont.h \
NSFontManager.h \
NSFontPanel.h \
NSForm.h \
NSFormCell.h \
NSGraphicsContext.h \
NSHelpPanel.h \
NSHelpManager.h \
NSImage.h \
NSImageCell.h \
NSImageRep.h \
NSImageView.h \
NSInputManager.h \
NSInputServer.h \
NSInterfaceStyle.h \
NSLayoutManager.h \
NSMatrix.h \
NSMenu.h \
NSMenuItem.h \
NSMenuItemCell.h \
NSMenuView.h \
NSOpenPanel.h \
NSOutlineView.h \
NSPageLayout.h \
NSPanel.h \
NSParagraphStyle.h \
NSPasteboard.h \
NSPopUpButton.h \
NSPopUpButtonCell.h \
NSPrintInfo.h \
NSPrintOperation.h \
NSPrintPanel.h \
NSPrinter.h \
NSProgressIndicator.h \
NSResponder.h \
NSRulerMarker.h \
NSRulerView.h \
NSSavePanel.h \
NSScreen.h \
NSScrollView.h \
NSScroller.h \
NSSecureTextField.h \
NSSelection.h \
NSSlider.h \
NSSliderCell.h \
NSSound.h \
NSSpellChecker.h \
NSSpellServer.h \
NSSplitView.h \
NSStepper.h \
NSStepperCell.h \
NSStringDrawing.h \
NSTabView.h \
NSTabViewItem.h \
NSTableColumn.h \
NSTableHeaderCell.h \
NSTableHeaderView.h \
NSTableView.h \
NSText.h \
NSTextAttachment.h \
NSTextContainer.h \
NSTextField.h \
NSTextFieldCell.h \
NSTextStorage.h \
NSTextView.h \
NSToolbar.h \
NSToolbarItem.h \
NSView.h \
NSWindow.h \
NSWindowController.h \
NSWorkspace.h
DOCUMENT_NAME = Gui
Gui_DOC_INSTALL_DIR = Developer
Gui_AGSDOC_FILES = ../Documentation/Gui.gsdoc $(AUTOGSDOC_HEADERS)
#
# Hack ... using the -DocumentationDirectory flag overrides the value
# used by the make package, and puts our output in the documentation
# directory.
#
Gui_AGSDOC_FLAGS = \
-DocumentationDirectory ../Documentation/Gui \
-HeaderDirectory ../Headers/AppKit \
-Declared AppKit \
-Standards YES \
-ConstantsTemplate TypesAndConstants \
-FunctionsTemplate Functions \
-MacrosTemplate Functions \
-TypedefsTemplate TypesAndConstants \
-VariablesTemplate TypesAndConstants \
-WordMap '{\
APPKIT_EXPORT=extern;APPKIT_DECLARE="";\
}' -Up Gui
include $(GNUSTEP_MAKEFILES)/documentation.make
#
# Clean up temporary files used while generating documentation.
#
after-all::
$(RM) Gui.gsdoc
rmdir Gui

View file

@ -178,24 +178,24 @@ endif
libgnustep-gui_HEADER_FILES_DIR = ../Headers/AppKit
libgnustep-gui_HEADER_FILES_INSTALL_DIR = /AppKit
DOCUMENT_NAME = Gui
Gui_AGSDOC_FILES = ../Documentation/Gui.gsdoc $(AUTOGSDOC_HEADERS)
Gui_AGSDOC_FLAGS = \
-DocumentationDirectory ../Documentation/Gui \
-HeaderDirectory ../Headers/AppKit \
-Declared AppKit \
-Standards YES \
-ConstantsTemplate TypesAndConstants \
-FunctionsTemplate Functions \
-TypedefsTemplate TypesAndConstants \
-VariablesTemplate TypesAndConstants \
-WordMap '{\
APPKIT_EXPORT=extern;APPKIT_DECLARE="";\
}' -Up Gui
# These are gui headers that are also classes documented with autogsdoc
AUTOGSDOC_HEADERS = \
libgnustep-gui_HEADER_FILES = \
AppKit.h \
GSVersion.h \
AppKitDefines.h \
AppKitExceptions.h \
DPSOperators.h \
GMAppKit.h \
GMArchiver.h \
GSFontInfo.h \
GSMemoryPanel.h \
GSInfoPanel.h \
GSMethodTable.h \
GSPasteboardServer.h \
GSServicesManager.h \
GSTextConverter.h \
GSTrackingRect.h \
GSHelpManagerPanel.h \
GSNibTemplates.h \
GSDisplayServer.h \
GSFusedSilica.h \
GSTable.h \
@ -303,27 +303,7 @@ NSToolbarItem.h \
NSView.h \
NSWindow.h \
NSWindowController.h \
NSWorkspace.h
libgnustep-gui_HEADER_FILES = \
AppKit.h \
GSVersion.h \
AppKitDefines.h \
AppKitExceptions.h \
DPSOperators.h \
GMAppKit.h \
GMArchiver.h \
GSFontInfo.h \
GSMemoryPanel.h \
GSInfoPanel.h \
GSMethodTable.h \
GSPasteboardServer.h \
GSServicesManager.h \
GSTextConverter.h \
GSTrackingRect.h \
GSHelpManagerPanel.h \
GSNibTemplates.h \
$(AUTOGSDOC_HEADERS) \
NSWorkspace.h \
IMConnectors.h \
IMCustomObject.h \
IMLoading.h \
@ -348,9 +328,4 @@ include GNUmakefile.preamble
include $(GNUSTEP_MAKEFILES)/library.make
# Only build the doc if doc=yes was passed on the command line
ifeq ($(doc),yes)
include $(GNUSTEP_MAKEFILES)/documentation.make
endif
include GNUmakefile.postamble