Mercurial > SimpleWebPresenter

changeset 51:2cfea6e84694

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation update.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Thu, 11 Oct 2012 00:06:26 +0200
parents 2d0cda52f43f
children 2e6ba7259281
files Doxyfile accept-language.inc common-functions.inc constants.inc filters.inc flag.php index.php inputParser.inc logger.inc sitemap.php
diffstat 10 files changed, 44 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Doxyfile	Tue Oct 09 20:15:20 2012 +0200
+++ b/Doxyfile	Thu Oct 11 00:06:26 2012 +0200
@@ -38,7 +38,7 @@
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = "An extremely simple CMS"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not
--- a/accept-language.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/accept-language.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,15 @@
 <?php
+/**
+ * @file
+ * Functionality for determining language use
+ */
+
+/**
+ * Extracts the accepted languages from the GET query, sorted by
+ * preference(q-value).
+ *
+ * @return associative array of language codes with q value
+ */
 function acceptedLanguages() {
   $langs = array();
 
--- a/common-functions.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/common-functions.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Functionality which doesn't belong anywhere else
+ */
 include_once 'CacheTimeCheck.inc';
 
 $cache = CacheTimeCheck::instance(__FILE__);
--- a/constants.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/constants.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Definitions of constants
+ */
 define(VERBOSITY_NONE, 0);
 define(VERBOSITY_ERROR, 1);
 define(VERBOSITY_WARNING, 10);
--- a/filters.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/filters.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Filters which may be used from xml
+ */
 function activeNav($input, $options)
 {
   $name = $options->getName();
--- a/flag.php	Tue Oct 09 20:15:20 2012 +0200
+++ b/flag.php	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Displays a flag, in an active or disabled state, depending on parameters
+ */
 define(DEBUG,0);
 
 include_once 'CacheTimeCheck.inc';
--- a/index.php	Tue Oct 09 20:15:20 2012 +0200
+++ b/index.php	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Main access point for webpages
+ */
 include_once 'constants.inc';
 
 $cacheable = true;
--- a/inputParser.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/inputParser.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Functionality for translating an XML document into a webpage
+ */
 function getParam($param)
 {
   $param_type=$param->getAttribute("type");
--- a/logger.inc	Tue Oct 09 20:15:20 2012 +0200
+++ b/logger.inc	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Common access point for logging
+ */
 function logMsg($level, $msg)
 {
   if (DEBUG_LEVEL >= $level) {
--- a/sitemap.php	Tue Oct 09 20:15:20 2012 +0200
+++ b/sitemap.php	Thu Oct 11 00:06:26 2012 +0200
@@ -1,4 +1,8 @@
 <?
+/**
+ * @file
+ * Generates a sitemap
+ */
 header('Content-type: application/xml');
 print '<?xml version="1.0" encoding="UTF-8"?>';
 print "\n";