libs-base/Source/DocMakefile

#
#  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

include $(GNUSTEP_MAKEFILES)/common.make
include ../config.mak

DOCUMENT_NAME = Base BaseAdditions

Base_DOC_INSTALL_DIR = Developer
BaseAdditions_DOC_INSTALL_DIR = Developer

Base_AGSDOC_FILES = \
../Documentation/Base.gsdoc \
NSArchiver.h \
NSArray.h \
NSAttributedString.h \
NSAutoreleasePool.h \
NSBundle.h \
NSCalendarDate.h \
NSCharacterSet.h \
NSClassDescription.h \
NSCoder.h \
NSConnection.h \
NSData.h \
NSDate.h \
NSDateFormatter.h \
NSDebug.h \
NSDecimal.h \
NSDecimalNumber.h \
NSDictionary.h \
NSDistantObject.h \
NSDistributedLock.h \
NSDistributedNotificationCenter.h \
NSEnumerator.h \
NSError.h \
NSException.h \
NSFileHandle.h \
NSFileManager.h \
NSFormatter.h \
NSGeometry.h \
NSHashTable.h \
NSHost.h \
NSIndexSet.h \
NSInvocation.h \
NSKeyedArchiver.h \
NSKeyValueCoding.h \
NSLock.h \
NSMapTable.h \
NSMethodSignature.h \
NSNotification.h \
NSNotificationQueue.h \
NSNull.h \
NSNumberFormatter.h \
NSObjCRuntime.h \
NSObject.h \
NSPathUtilities.h \
NSPort.h \
NSPortCoder.h \
NSPortMessage.h \
NSPortNameServer.h \
NSPropertyList.h \
NSProcessInfo.h \
NSProtocolChecker.h \
NSProxy.h \
NSRange.h \
NSRunLoop.h \
NSScanner.h \
NSSerialization.h \
NSSet.h \
NSString.h \
NSTask.h \
NSThread.h \
NSTimeZone.h \
NSTimer.h \
NSURL.h \
NSURLHandle.h \
NSUndoManager.h \
NSUserDefaults.h \
NSValue.h \
NSXMLParser.h \
NSZone.h

BaseAdditions_AGSDOC_FILES = \
../Documentation/BaseAdditions.gsdoc \
GSCategories.h \
GSIArray.h \
GSIMap.h \
GSLock.h \
GSMime.h \
GSObjCRuntime.h \
GSUnion.h \
GSXML.h \
GSFunctions.h \
behavior.h \
Unicode.h \
GCObject.h \


#
# Hack ... using the -DocumentationDirectory flag overrides the value
# used by the make package, and puts our output in the documentation
# directory.
#
Base_AGSDOC_FLAGS = \
	-MakeFrames YES \
	-DocumentationDirectory ../Documentation/Base \
	-HeaderDirectory ../Headers/Foundation \
	-Declared Foundation \
	-Standards YES \
	-ConstantsTemplate TypesAndConstants \
	-FunctionsTemplate Functions \
	-MacrosTemplate Functions \
	-TypedefsTemplate TypesAndConstants \
	-VariablesTemplate TypesAndConstants \
	-WordMap '{\
	FOUNDATION_EXPORT=extern;FOUNDATION_STATIC_INLINE="";\
	GS_STATIC_INLINE="";\
	GS_GEOM_SCOPE=extern;GS_GEOM_ATTR="";\
	GS_EXPORT=extern;GS_DECLARE="";\
	GS_RANGE_SCOPE=extern;GS_RANGE_ATTR="";\
	GS_ZONE_SCOPE=extern;GS_ZONE_ATTR="";\
	INLINE=inline;\
	}' -Up Base

BaseAdditions_AGSDOC_FLAGS = \
	-MakeFrames YES \
	-DocumentationDirectory ../Documentation/BaseAdditions \
	-HeaderDirectory ../Headers/Additions/GNUstepBase \
	-Declared GNUstepBase \
	-Standards YES \
	-ConstantsTemplate TypesAndConstants \
	-FunctionsTemplate Functions \
	-MacrosTemplate Functions \
	-TypedefsTemplate TypesAndConstants \
	-VariablesTemplate TypesAndConstants \
	-WordMap '{\
	FOUNDATION_EXPORT=extern;FOUNDATION_STATIC_INLINE="";\
	GS_GEOM_SCOPE=extern;GS_GEOM_ATTR="";\
	GS_EXPORT=extern;GS_DECLARE="";\
	GS_RANGE_SCOPE=extern;GS_RANGE_ATTR="";\
	GS_ZONE_SCOPE=extern;GS_ZONE_ATTR="";\
	INLINE=inline;\
	}' -Up BaseAdditions

# Use local version of autogsdoc in case it is not installed
AUTOGSDOC=../Tools/obj/autogsdoc

# Fool make into thinking we are installed even if we are not
BASE_MAKE_LOADED=yes

include $(GNUSTEP_MAKEFILES)/documentation.make

#
# Ensure that our destination subdirectory exists in the Documentation
# directory, and temporarily copy the base source file here for autogsdoc
# to use.
#
before-all::	../Documentation/Base \
	../Documentation/Base/Functions.gsdoc \
	../Documentation/Base/TypesAndConstants.gsdoc \
	../Documentation/BaseAdditions \
	../Documentation/BaseAdditions/Functions.gsdoc \
	../Documentation/BaseAdditions/TypesAndConstants.gsdoc
	cp ../Documentation/Base.gsdoc .
	cp ../Documentation/BaseAdditions.gsdoc .

../Documentation/Base:
	$(MKDIRS) ../Documentation/Base

../Documentation/Base/Functions.gsdoc: ../Documentation/Functions.gsdoc
	cp ../Documentation/Functions.gsdoc ../Documentation/Base

../Documentation/Base/TypesAndConstants.gsdoc: \
	../Documentation/TypesAndConstants.gsdoc
	cp ../Documentation/TypesAndConstants.gsdoc ../Documentation/Base

../Documentation/BaseAdditions:
	$(MKDIRS) ../Documentation/BaseAdditions

../Documentation/BaseAdditions/Functions.gsdoc: \
	../Documentation/Functions.gsdoc
	cp ../Documentation/Functions.gsdoc ../Documentation/BaseAdditions

../Documentation/BaseAdditions/TypesAndConstants.gsdoc: \
	../Documentation/TypesAndConstants.gsdoc
	cp ../Documentation/TypesAndConstants.gsdoc \
	../Documentation/BaseAdditions

#
# Work around our screwy doc generation implementation, sigh...
#
before-clean::
	if [ -e obj ]; then \
	  mv obj obj-save-link; \
	fi

#
# Clean up temporary files used while generating documentation.
#
after-clean::
	$(RM) Base.gsdoc
	$(RM) BaseAdditions.gsdoc
	if [ -d Base ]; then \
	  $(RM) Base/stamp; \
	  $(RM) Base/dependencies; \
	  rmdir Base; \
	  $(RM) BaseAdditions/stamp; \
	  $(RM) BaseAdditions/dependencies; \
	  rmdir BaseAdditions; \
	fi
	if [ -e obj-save-link ]; then \
	  mv obj-save-link obj; \
	fi