start formatting for Doxygen

boot.php

@@ -1,4 +1,5 @@
 <?php
+/** @file */
 
 require_once('include/config.php');
 require_once('include/network.php');

include/BaseObject.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 if(class_exists('BaseObject'))
 	return;
 

include/Contact.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function abook_connections($channel_id, $sql_conditions = '') {

include/ConversationObject.php

@@ -1,4 +1,5 @@
-<?php
+<?php /** @file */
+
 if(class_exists('Conversation'))
 	return;
 

include/ItemObject.php

@@ -1,4 +1,5 @@
-<?php
+<?php /** @file */
+
 if(class_exists('Item'))
 	return;
 

include/Photo.php

@@ -1,6 +1,6 @@
-<?php
+<?php /** @file */
+
 
-if(! class_exists("Photo")) {
 class Photo {
 
 	private $image;
@@ -605,7 +605,7 @@ class Photo {
 		}
 		return $r;
 	}
-}}
+}
 
 
 /**

include/ProtoDriver.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 /*
  * Abstraction class for dealing with alternate networks (which of course do not exist, hence the abstraction)

include/Scrape.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('library/HTML5/Parser.php');
 require_once('include/crypto.php');

include/account.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/config.php');
 require_once('include/network.php');

include/acl_selectors.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 /**
  * 
  */

include/activities.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function profile_activity($changed, $value) {
 	$a = get_app();

include/api.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("bbcode.php");
 require_once("datetime.php");

include/attach.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 /*
  * File/attach API with the potential for revision control.

include/auth.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 require_once('include/security.php');

include/bb2diaspora.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("include/oembed.php");
 require_once("include/event.php");

include/bbcode.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("include/oembed.php");
 require_once('include/event.php');

include/cache.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 	/**
 	 *  cache api

include/cli_startup.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('boot.php');
 

include/config.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 /**
  *

include/contact_selectors.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function contact_profile_assign($current,$foreign_net) {

include/contact_widgets.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function follow_widget() {
 

include/conversation.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/items.php');
 

include/cronhooks.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('boot.php');
 require_once('include/cli_startup.php');

include/crypto.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('library/ASNValue.class.php');
 require_once('library/asn1.php');

include/datetime.php

@@ -1,8 +1,8 @@
-<?php
+<?php /** @file */
 
 // two-level sort for timezones.
 
-if(! function_exists('timezone_cmp')) {
+
 function timezone_cmp($a, $b) {
 	if(strstr($a,'/') && strstr($b,'/')) {
 		if ( t($a) == t($b)) return 0;
@@ -12,10 +12,10 @@ function timezone_cmp($a, $b) {
 	if(strstr($b,'/')) return  1;
 	if ( t($a) == t($b)) return 0;
 	return ( t($a) < t($b)) ? -1 : 1;
-}}
+}
 
 // emit a timezone selector grouped (primarily) by continent
-if(! function_exists('select_timezone')) {
+
 function select_timezone($current = 'America/Los_Angeles') {
 
 	$timezone_identifiers = DateTimeZone::listIdentifiers();
@@ -52,13 +52,13 @@ function select_timezone($current = 'America/Los_Angeles') {
 	}    
 	$o .= '</optgroup></select>';
 	return $o;
-}}
+}
 
 // return a select using 'field_select_raw' template, with timezones 
 // groupped (primarily) by continent
 // arguments follow convetion as other field_* template array:
 // 'name', 'label', $value, 'help'
-if (!function_exists('field_timezone')){
+
 function field_timezone($name='timezone', $label='', $current = 'America/Los_Angeles', $help){
 	$options = select_timezone($current);
 	$options = str_replace('<select id="timezone_select" name="timezone">','', $options);
@@ -69,7 +69,7 @@ function field_timezone($name='timezone', $label='', $current = 'America/Los_Ang
 		'$field' => array($name, $label, $current, $help, $options),
 	));
 	
-}}
+}
 
 // General purpose date parse/convert function.
 // $from = source timezone
@@ -77,7 +77,7 @@ function field_timezone($name='timezone', $label='', $current = 'America/Los_Ang
 // $s    = some parseable date/time string
 // $fmt  = output format
 
-if(! function_exists('datetime_convert')) {
+
 function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d H:i:s") {
 
 	// Defaults to UTC if nothing is set, but throws an exception if set to empty string.
@@ -124,7 +124,7 @@ function datetime_convert($from = 'UTC', $to = 'UTC', $s = 'now', $fmt = "Y-m-d
 
 	$d->setTimeZone($to_obj);
 	return($d->format($fmt));
-}}
+}
 
 // wrapper for date selector, tailored for use in birthday fields
 
@@ -180,7 +180,7 @@ function datesel_format($f) {
 // $m           = already selected month
 // $d           = already selected day
 
-if(! function_exists('datesel')) {
+
 function datesel($f,$pre,$ymin,$ymax,$allow_blank,$y,$m,$d) {
 
 	$o = '';
@@ -231,9 +231,9 @@ function datesel($f,$pre,$ymin,$ymax,$allow_blank,$y,$m,$d) {
 
 	$o .= "</select>";
 	return $o;
-}}
+}
+
 
-if(! function_exists('timesel')) {
 function timesel($pre,$h,$m) {
 
 	$o = '';
@@ -250,7 +250,7 @@ function timesel($pre,$h,$m) {
 
 	$o .= "</select>";
 	return $o;
-}}
+}
 
 
 
@@ -264,7 +264,7 @@ function timesel($pre,$h,$m) {
 // Results relative to current timezone
 // Limited to range of timestamps
 
-if(! function_exists('relative_date')) {
+
 function relative_date($posted_date,$format = null) {
 
 	$localtime = datetime_convert('UTC',date_default_timezone_get(),$posted_date); 
@@ -300,7 +300,7 @@ function relative_date($posted_date,$format = null) {
 			return sprintf( $format,$r, (($r == 1) ? $str[0] : $str[1]));
         }
     }
-}}
+}
 
 
 
@@ -341,7 +341,7 @@ function age($dob,$owner_tz = '',$viewer_tz = '') {
 // $month[1] = 'January'; 
 //   to match human usage.
 
-if(! function_exists('get_dim')) {
+
 function get_dim($y,$m) {
 
   $dim = array( 0,
@@ -353,7 +353,7 @@ function get_dim($y,$m) {
   if(((($y % 4) == 0) && (($y % 100) != 0)) || (($y % 400) == 0))
     return 29;
   return $dim[2];
-}}
+}
 
 
 // Returns the first day in month for a given month, year
@@ -361,11 +361,11 @@ function get_dim($y,$m) {
 // returns 0 = Sunday through 6 = Saturday
 // Months start at 1.
 
-if(! function_exists('get_first_dim')) {
+
 function get_first_dim($y,$m) {
   $d = sprintf('%04d-%02d-01 00:00', intval($y), intval($m));
   return datetime_convert('UTC','UTC',$d,'w');
-}}
+}
 
 // output a calendar for the given month, year.
 // if $links are provided (array), e.g. $links[12] => 'http://mylink' , 
@@ -376,8 +376,6 @@ function get_first_dim($y,$m) {
 
 // TODO: provide (prev,next) links, define class variations for different size calendars
 
-
-if(! function_exists('cal')) {
 function cal($y = 0,$m = 0, $links = false, $class='') {
 
 
@@ -442,6 +440,6 @@ function cal($y = 0,$m = 0, $links = false, $class='') {
   $o .= '</tr></table>'."\r\n";  
   
   return $o;
-}}
+}
 
 

include/dba.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/datetime.php');
 

include/deliver.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/cli_startup.php');
 require_once('include/zot.php');

include/dir_fns.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/permissions.php');
 

include/directory.php

@@ -1,4 +1,5 @@
-g<?php
+<?php /** @file */
+
 require_once('boot.php');
 require_once('include/zot.php');
 require_once('include/cli_startup.php');

include/enotify.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function notification($params) {
 

include/event.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function format_event_html($ev) {

include/expire.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('boot.php');
 require_once('include/cli_startup.php');

include/fcontact.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 

include/features.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 /*
  * Features management

include/follow.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 //

include/friendica_smarty.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("library/Smarty/libs/Smarty.class.php");
 

include/gprobe.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/cli_startup.php');
 require_once('include/zot.php');

include/group.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function group_add($uid,$name) {

include/html2bbcode.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 /*
 html2bbcode.php
 Converter for HTML to BBCode

include/html2plain.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 require_once "html2bbcode.php";
 
 function breaklines($line, $level, $wraplength = 75)

include/identity.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/zot.php');
 require_once('include/crypto.php');

include/iquery.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function network_query($a,$arr) {

include/items.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/bbcode.php');
 require_once('include/oembed.php');

include/js_strings.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function js_strings() {
 	return replace_macros(get_markup_template('js_strings.tpl'), array(

include/language.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 /**

include/message.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 /* Private Message backend API */
 

include/nav.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function nav(&$a) {
 

include/network.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 

include/notifier.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("boot.php");
 require_once('include/queue_fn.php');

include/notify.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function format_notification($item) {

include/oauth.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 /** 
  * OAuth server
  * Based on oauth2-php <http://code.google.com/p/oauth2-php/>

include/oembed.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 function oembed_replacecb($matches){
 //	logger('oembedcb');
 	$embedurl=$matches[1];

include/onepoll.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('boot.php');
 require_once('include/cli_startup.php');

include/permissions.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function get_perms() {

include/photos.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/permissions.php');
 require_once('include/items.php');

include/plugin.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once("include/friendica_smarty.php");
 

include/poller.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('boot.php');
 require_once('include/cli_startup.php');

include/profile_advanced.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function advanced_profile(&$a) {
 

include/profile_selectors.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 
 function gender_selector($current="",$suffix="") {

include/queue.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 require_once("boot.php");
 require_once('include/cli_startup.php');
 require_once('include/queue_fn.php');

include/queue_fn.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function update_queue_time($id) {
 	logger('queue: requeue item ' . $id);

include/security.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function authenticate_success($user_record, $login_initial = false, $interactive = false,$return = false,$update_lastlog = false) {
 

include/session.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 // Session management functions. These provide database storage of PHP
 // session info.

include/socgraph.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/zot.php');
 

include/system_unavailable.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 function system_down() {
 echo <<< EOT

include/template_processor.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 	define ("KEY_NOT_EXISTS", '^R_key_not_Exists^');
 
 	class Template {

include/text.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 // This is our template processor.
 // $s is the string requiring macro substitution.

include/zot.php

@@ -1,4 +1,4 @@
-<?php
+<?php /** @file */
 
 require_once('include/crypto.php');
 require_once('include/items.php');

version.inc

@@ -1 +1 @@
-2013-02-24.234
+2013-02-25.235