Commits

Anonymous committed d8f1cc6

- added a headerDoc2HTML config file with our copyright notice
- added a headerdoc target to the Makefile
- added a Growl.hdoc file which should contain some documentation about the framework

Comments (0)

Files changed (4)

Framework/Source/Growl.hdoc

+/*!
+ * @framework Growl Framework
+ * @abstract Growl notification framework
+ * @discussion The Growl framework provides an easy way to integrate Growl
+ *  notifications into your application. The framework should be part of
+ *  your application bundle, it should not be installed in /Library/Frameworks
+ *  or ~/Library/Frameworks.
+ */

Growl.xcode/project.pbxproj

 			projectDirPath = "";
 			projectReferences = (
 				{
+					ProductGroup = 95D1659E0834DB5200D996B2;
+					ProjectRef = 95D1659D0834DB5200D996B2;
+				},
+				{
 					ProductGroup = 95D165B70834DB7500D996B2;
 					ProjectRef = 95D165B60834DB7500D996B2;
 				},
-				{
-					ProductGroup = 95D1659E0834DB5200D996B2;
-					ProjectRef = 95D1659D0834DB5200D996B2;
-				},
 			);
 			targets = (
 				8D202CE80486D31800D8A456,
 GROWL_FRAMEWORK=Growl.framework
 BUILD_DIR=build
 GROWL_HELPER_APP=$(PREFERENCEPANES_DIR)/$(GROWL_PREFPANE)/Contents/Resources/GrowlHelperApp.app
+HEADERDOC_DIR=Docs/HeaderDoc
 
 #DEFAULT_BUILDSTYLE=Deployment
 DEFAULT_BUILDSTYLE=Development
 	$(CP) $(BUILD_DIR)/$(GROWL_PREFPANE) $(PREFERENCEPANES_DIR)/$(GROWL_PREFPANE)
 	open $(GROWL_HELPER_APP)
 
+headerdoc:
+	rm -rf $(HEADERDOC_DIR)
+	headerdoc2html -o $(HEADERDOC_DIR) Common/Source/GrowlDefines.h Common/Source/GrowlDefinesInternal.h Framework/Source/GrowlInstallationPrompt.h Framework/Source/GrowlInstallationPrompt-Carbon.h Framework/Source/GrowlApplicationBridge.h Framework/Source/GrowlApplicationBridge-Carbon.h Common/Source/GrowlPathUtil.h Framework/Source/GrowlDelegate.h Display\ Plugins/GrowlDisplayProtocol.h Framework/Source/Growl.hdoc
+	gatherheaderdoc $(HEADERDOC_DIR)
+
 uninstall:
 	killall GrowlHelperApp || true
 	@if [ -d "/Library/PreferencePanes/Growl.prefPane" ]; then \

headerDoc2HTML.config

+copyrightOwner => The Growl Project
+