#-------------------------------------------------------------------------------
# Copyright (c) 2012, Jean-David Gadina - www.xs-labs.com
# All rights reserved.
# 
# Boost Software License - Version 1.0 - August 17th, 2003
# 
# Permission is hereby granted, free of charge, to any person or organization
# obtaining a copy of the software and accompanying documentation covered by
# this license (the "Software") to use, reproduce, display, distribute,
# execute, and transmit the Software, and to prepare derivative works of the
# Software, and to permit third-parties to whom the Software is furnished to
# do so, all subject to the following:
# 
# The copyright notices in the Software and this entire statement, including
# the above license grant, this restriction and the following disclaimer,
# must be included in all copies of the Software, in whole or in part, and
# all derivative works of the Software, unless such copies or derivative
# works are solely in the form of machine-executable object code generated by
# a source language processor.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
# SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
# FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#-------------------------------------------------------------------------------

# $Id$

# Check for the XSDocgen utility
_HAS_XSDOCGEN       := $(shell if [ -f "/usr/local/bin/XSDocgen" ]; then echo true; else echo false; fi )

#-------------------------------------------------------------------------------
# Built-in targets
#-------------------------------------------------------------------------------

# Declaration for phony targets, to avoid problems with local files
.PHONY: all             \
        verbose

#-------------------------------------------------------------------------------
# Phony targets
#-------------------------------------------------------------------------------

# Documentation
all:
	
ifeq ($(_HAS_XSDOCGEN),true)
	@echo $(call _PRINT,XSDoc,universal,Generating the documentation)
	@/usr/local/bin/XSDocgen \
	@    --clear \
	@    --source ../ClangKit \
	@    --output . \
	@    --exclude-file HeaderDoc-Exclude.txt \
	@    --project-name "ClangKit" \
	@    --project-copyright "XS-Labs &copy; %Y - All Rights Reserved" \
	@    --project-version "1.0.0-0" \
	@    --project-timezone "Europe/Zurich" \
	@    --company-name "XS-Labs" \
	@    --company-url "http://www.xs-labs.com/" \
	@    --page-home "Pages/Home.inc.php" \
	@    --source-root-prefix "/ClangKit/" \
	@    --page-add "Tutorial" "Pages/Tutorial.inc.php" \
	@    --google-analytics "UA-51035898-4" "xs-labs.com" \
	@    --google-analytics-display-features
else
	@echo $(call _PRINT,XSDoc,universal,Skipping documentation generation - XSDocgen is not installed)
endif
	
# Documentation (verbose mode)
verbose:
	
ifeq ($(_HAS_XSDOCGEN),true)
	@echo $(call _PRINT,XSDoc,universal,Generating the documentation)
	@/usr/local/bin/XSDocgen \
	@    --verbose \
	@    --clear \
	@    --source ../ClangKit \
	@    --output . \
	@    --exclude-file HeaderDoc-Exclude.txt \
	@    --project-name "ClangKit" \
	@    --project-copyright "XS-Labs &copy; %Y - All Rights Reserved" \
	@    --project-version "1.0.0-0" \
	@    --project-timezone "Europe/Zurich" \
	@    --company-name "XS-Labs" \
	@    --company-url "http://www.xs-labs.com/" \
	@    --page-home "Pages/Home.inc.php" \
	@    --source-root-prefix "/ClangKit/"
	@    --page-add "Tutorial" "Pages/Tutorial.inc.php" \
	@    --google-analytics "UA-51035898-4" "xs-labs.com" \
	@    --google-analytics-display-features
else
	@echo $(call _PRINT,XSDoc,universal,Skipping documentation generation - XSDocgen is not installed)
endif
