From 71b0bc0d1ba44decbb0a2674b18f7fc7a678a200 Mon Sep 17 00:00:00 2001 From: Zachary Doll Date: Mon, 25 Aug 2014 15:53:37 -0500 Subject: [PATCH] Replace phpdoc config with apigen config --- apigen.neon | 40 ++++++++++++++++++++++++++++++++++++++++ phpdoc.dist.xml | 20 -------------------- 2 files changed, 40 insertions(+), 20 deletions(-) create mode 100644 apigen.neon delete mode 100644 phpdoc.dist.xml diff --git a/apigen.neon b/apigen.neon new file mode 100644 index 0000000..ef09a09 --- /dev/null +++ b/apigen.neon @@ -0,0 +1,40 @@ +# Source file or directory to parse +source: ./ +# Directory where to save the generated documentation +destination: ./doc/en +# List of allowed file extensions +extensions: [php] +# Mask to exclude file or directory from processing +exclude: +# Don't generate documentation for classes from file or directory with this mask +skipDocPath: doc +# Title of generated documentation +title: Yaga +# Documentation base URL +baseUrl: http://hgtonight.github.io/Application-Yaga/en/ +# Generate documentation for PHP internal classes +php: No +# Generate tree view of classes, interfaces and exceptions +tree: Yes +# Generate documentation for deprecated classes, methods, properties and constants +deprecated: No +# Generate documentation of tasks +todo: Yes +# Generate highlighted source code files +sourceCode: Yes +# Add a link to download documentation as a ZIP archive +download: Yes +# Save a checkstyle report of poorly documented elements into a file +report: ./doc/report.xml +# Wipe out the destination directory first +wipeout: Yes +# Don't display scanning and generating messages +quiet: No +# Display progressbars +progressbar: Yes +# Use colors +colors: Yes +# Check for update +updateCheck: Yes +# Display additional information in case of an error +debug: No \ No newline at end of file diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml deleted file mode 100644 index 06da753..0000000 --- a/phpdoc.dist.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - Yaga Technical Documentation - - doc/stage/ - - TODO - - - - doc/en/ - - -