From d5a764afae9ca36f7142b68a6154850a3c3cc312 Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Fri, 8 Jun 2007 11:21:39 +0000 Subject: [PATCH 1/3] Update doxyfile --- scripts/build.docs.doxygen/Doxyfile.in | 43 +++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/scripts/build.docs.doxygen/Doxyfile.in b/scripts/build.docs.doxygen/Doxyfile.in index 304645e..d641e07 100644 --- a/scripts/build.docs.doxygen/Doxyfile.in +++ b/scripts/build.docs.doxygen/Doxyfile.in @@ -5,11 +5,11 @@ # http://www.gnu.org/copyleft/gpl.html for details. # +DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = @P@ OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English -USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = @@ -23,11 +23,14 @@ JAVADOC_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = YES DETAILS_AT_TOP = YES INHERIT_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO +SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES EXTRACT_ALL = NO EXTRACT_PRIVATE = NO @@ -62,11 +65,13 @@ WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = +INPUT_ENCODING = UTF-8 FILE_PATTERNS = RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO @@ -79,6 +84,8 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO VERBATIM_HEADERS = NO ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 @@ -101,11 +108,37 @@ ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = NO TREEVIEW_WIDTH = 250 GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO @@ -121,6 +154,7 @@ ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES +MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES CLASS_GRAPH = YES @@ -131,14 +165,13 @@ TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO +CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = NO DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = -MAX_DOT_GRAPH_WIDTH = 1024 -MAX_DOT_GRAPH_HEIGHT = 1024 -MAX_DOT_GRAPH_DEPTH = 0 +DOT_GRAPH_MAX_NODES = 50 DOT_TRANSPARENT = YES DOT_MULTI_TARGETS = YES GENERATE_LEGEND = YES From 9ff26c074880f721eddcd61066a471994291ad85 Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Fri, 8 Jun 2007 11:21:53 +0000 Subject: [PATCH 2/3] Add plain documentation --- scripts/build.docs.none/build.install | 1 + scripts/build.docs.none/build.install-docs | 14 ++++++++++++++ scripts/build.docs.none/instantiate | 12 ++++++++++++ 3 files changed, 27 insertions(+) create mode 100644 scripts/build.docs.none/build.install create mode 100644 scripts/build.docs.none/build.install-docs create mode 100644 scripts/build.docs.none/instantiate diff --git a/scripts/build.docs.none/build.install b/scripts/build.docs.none/build.install new file mode 100644 index 0000000..53e467a --- /dev/null +++ b/scripts/build.docs.none/build.install @@ -0,0 +1 @@ +source src/@NAME@/build.install-docs diff --git a/scripts/build.docs.none/build.install-docs b/scripts/build.docs.none/build.install-docs new file mode 100644 index 0000000..8a59f39 --- /dev/null +++ b/scripts/build.docs.none/build.install-docs @@ -0,0 +1,14 @@ +# create destination directories +echo "Installing documentation into ${DOCSDIR}" +build_dir_tree "${DOCSDIR}" || return 1 + +# copy across the files (note this copies everything with mode 0644). +for file in src/@NAME@/* +do + [ "$(echo $(basename ${file}) | cut -b1-6)" == "build." ] && continue + install_file ${file} ${DOCSDIR} 0644 || return 1 +done + +print_success "Documentation installed" +# kate: @KATE_MODELINE@ +# vim: @VIM_MODELINE@ diff --git a/scripts/build.docs.none/instantiate b/scripts/build.docs.none/instantiate new file mode 100644 index 0000000..5c0eb7c --- /dev/null +++ b/scripts/build.docs.none/instantiate @@ -0,0 +1,12 @@ +if [ $# -ne 0 ] +then + print_failure "Too many arguments. None required for this module." + exit 1 +fi + +do_parameter_subst +add_config_option "DOCSDIR" "${COPT_DOCSDIR_DEFAULT}" +true + +# kate: replace-trailing-space-save true; space-indent true; tab-width 4; +# vim: expandtab:ts=4:sw=4 From 66bbbe1b0f2214935bf266b15461af3feaa05bb2 Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Fri, 8 Jun 2007 11:22:18 +0000 Subject: [PATCH 3/3] Add new entry to .gitignore --- skel/scripts/.gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/skel/scripts/.gitignore b/skel/scripts/.gitignore index 82ea507..31360b1 100644 --- a/skel/scripts/.gitignore +++ b/skel/scripts/.gitignore @@ -3,6 +3,7 @@ build.app.c++ build.app.c++-qt build.app.sh build.docs.doxygen +build.docs.none build.files.none build.firmware.gpasm build.firmware.sdcc