Skip to content

Commit

Permalink
Fix reference documentation generation with doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
Luca Bruno committed May 12, 2015
1 parent d5af5f3 commit 6844bf4
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ profile
entrust_root_certification_authority.pem
server_certificates_bundle_sandbox.pem
*~
Doc/Reference/html
12 changes: 6 additions & 6 deletions Doc/Reference/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NUMBER =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY = [[[!!OUTPUT!!]]]
OUTPUT_DIRECTORY =

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
Expand Down Expand Up @@ -105,7 +105,7 @@ INLINE_INHERITED_MEMB = NO
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES = YES
FULL_PATH_NAMES = NO

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
Expand All @@ -114,7 +114,7 @@ FULL_PATH_NAMES = YES
# If left blank the directory from which doxygen is run is used as the
# path to strip.

STRIP_FROM_PATH = "[[[!!INPUT!!]]]"
STRIP_FROM_PATH =

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
Expand Down Expand Up @@ -564,7 +564,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.

INPUT = "[[[!!INPUT!!]]]"
INPUT = "../../ApnsPHP"

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Expand Down Expand Up @@ -690,7 +690,7 @@ INPUT_FILTER =
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
# is applied to all files.

FILTER_PATTERNS = *.php="[[[!!FILTER-PATH!!]]]"
FILTER_PATTERNS = *.php="./php-input-filter.sh"

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
Expand Down Expand Up @@ -1467,7 +1467,7 @@ DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.

DOT_PATH = [[[!!DOT_PATH!!]]]
DOT_PATH =

# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
Expand Down
8 changes: 8 additions & 0 deletions Doc/Reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ApnsPHP reference documentation
================

1. Install doxygen and graphviz
1. `cd Doc/Reference`
1. Run `doxygen`

The html documentation will be generated in `Doc/Reference/html`.
3 changes: 1 addition & 2 deletions Doc/Reference/php-input-filter
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#!/usr/bin/php -q
<?php
/**
* @file
Expand Down Expand Up @@ -182,4 +181,4 @@ function _r_pos(&$aTokens)
while(next($aTokens) && key($aTokens) < $GLOBALS['__PREV__POSITION__']);
return;
}
}
}
2 changes: 2 additions & 0 deletions Doc/Reference/php-input-filter.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/sh
php -q php-input-filter $@

0 comments on commit 6844bf4

Please sign in to comment.