Use @todo: everywhere for phpdocumentor syntax.

This commit is contained in:
Andrew McMillan 2008-11-01 19:27:33 +13:00
parent 7e3e233839
commit ff87efdc1d
10 changed files with 17 additions and 17 deletions

View File

@ -352,7 +352,7 @@ class CalDAVPrincipal
case 'DAV::acl':
/**
* FIXME: This information is semantically valid but presents an incorrect picture.
* @todo: This information is semantically valid but presents an incorrect picture.
*/
$principal = new XMLElement("principal");
$principal->NewElement("authenticated");
@ -375,7 +375,7 @@ class CalDAVPrincipal
$prop->NewElement( $reply->Tag($tag));
break;
case 'SOME-DENIED-PROPERTY': /** TODO: indicating the style for future expansion */
case 'SOME-DENIED-PROPERTY': /** @todo: indicating the style for future expansion */
$denied[] = $reply->Tag($tag);
break;
@ -418,4 +418,4 @@ class CalDAVPrincipal
return $response;
}
}
}

View File

@ -388,7 +388,7 @@ EOSQL;
/**
* Checks whether the resource is locked, returning any lock token, or false
*
* FIXME: This logic does not catch all locking scenarios. For example an infinite
* @todo: This logic does not catch all locking scenarios. For example an infinite
* depth request should check the permissions for all collections and resources within
* that. At present we only maintain permissions on a per-collection basis though.
*

View File

@ -162,7 +162,7 @@ class HTTPAuthSession {
// generate the valid response
$user_password = "Don't be silly! Why would a user have a password like this!!?";
/**
* TODO: At this point we need to query the database for something fitting
* @todo: At this point we need to query the database for something fitting
* either strategy (A) or (B) above, in order to set $user_password to
* something useful!
*/

View File

@ -51,8 +51,8 @@ else {
$response = iCalendar::iCalHeader();
/**
* TODO: CalDAVRequest should have read the collection record, so we should not have to reread it here
* TODO: This should be structured to not use the iCalHeader() and iCalFooter methods. See caldav-POST.php for the bones of a better approach.
* @todo: CalDAVRequest should have read the collection record, so we should not have to reread it here
* @todo: This should be structured to not use the iCalHeader() and iCalFooter methods. See caldav-POST.php for the bones of a better approach.
*/
$collqry = new PgQuery( "SELECT * FROM collection WHERE collection.user_no = ? AND collection.dav_name = ?;", $request->user_no, $request->path);
if ( $collqry->Exec("GET") && $collection = $collqry->Fetch() ) {

View File

@ -52,7 +52,7 @@ if ( isset($request->xml_tags) ) {
case 'DAV::displayname':
$displayname = $content;
/**
* TODO: This is definitely a bug in SOHO Organizer and we probably should respond
* @todo: This is definitely a bug in SOHO Organizer and we probably should respond
* with an error, rather than silently doing what they *seem* to want us to do.
*/
if ( preg_match( '/^SOHO.Organizer.6\./', $_SERVER['HTTP_USER_AGENT'] ) ) {
@ -144,7 +144,7 @@ else {
}
/**
* FIXME: We could also respond to the request...
* @todo: We could also respond to the request...
*
* <?xml version="1.0" encoding="utf-8" ?>
* <C:mkcalendar xmlns:D="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav">

View File

@ -90,7 +90,7 @@ function handle_freebusy_request( $ic ) {
$where .= "AND (calendar_item.status != 'CANCELLED' OR calendar_item.status IS NULL) ";
/**
* @TODO Some significant permissions need to be added around the visibility of free/busy
* @todo Some significant permissions need to be added around the visibility of free/busy
* but lets get it working first...
*/
$where .= "AND (calendar_item.class != 'PRIVATE' OR calendar_item.class IS NULL) ";

View File

@ -257,7 +257,7 @@ function add_general_properties( &$prop, &$not_found, &$denied, $record ) {
if ( isset($prop_list['DAV::acl']) ) {
/**
* FIXME: This information is semantically valid but presents an incorrect picture.
* @todo: This information is semantically valid but presents an incorrect picture.
*/
$principal = new XMLElement("principal");
$principal->NewElement("authenticated");

View File

@ -93,7 +93,7 @@ function SqlFilterFragment( $filter, $components, $property = null, $parameter =
if ( isset( $property ) ) {
switch( $property ) {
case 'created':
case 'completed': /** when it can be handled in the SQL - see TODO: around line 160 below */
case 'completed': /** @todo: when it can be handled in the SQL - see around line 200 below */
case 'dtend':
case 'dtstamp':
case 'dtstart':
@ -113,7 +113,7 @@ function SqlFilterFragment( $filter, $components, $property = null, $parameter =
case 'urn:ietf:params:xml:ns:caldav:time-range':
/**
* TODO: We should probably allow time range queries against other properties, since eventually some client may want to do this.
* @todo: We should probably allow time range queries against other properties, since eventually some client may want to do this.
*/
$start_column = ($components[sizeof($components)-1] == 'VTODO' ? "due" : 'dtend'); // The column we compare against the START attribute
$finish_column = 'dtstart'; // The column we compare against the END attribute
@ -194,7 +194,7 @@ function SqlFilterFragment( $filter, $components, $property = null, $parameter =
$property = strtolower($propertyname);
break;
case 'COMPLETED': /** TODO: this should be moved into the properties supported in SQL. */
case 'COMPLETED': /** @todo: this should be moved into the properties supported in SQL. */
default:
$need_post_filter = true;
dbg_error_log("calquery", "Could not handle 'prop-filter' on %s in SQL", $propertyname );
@ -242,7 +242,7 @@ function BuildSqlFilter( $filter ) {
$responses = array();
/**
* FIXME: Once we are past DB version 1.2.1 we can change this query more radically. The best performance to
* @todo: Once we are past DB version 1.2.1 we can change this query more radically. The best performance to
* date seems to be:
* SELECT caldav_data.*,calendar_item.* FROM collection JOIN calendar_item USING (collection_id,user_no)
* JOIN caldav_data USING (dav_id) WHERE collection.dav_name = '/user1/home/'

View File

@ -1,7 +1,7 @@
<?php
/**
* @TODO Tidy up namespace handling in the responses.
* @todo Tidy up namespace handling in the responses.
*/
$responses = array();

View File

@ -150,7 +150,7 @@ function calendar_to_xml( $properties, $item ) {
case '"current-user-privilege-set"':
$prop->NewElement($k, privileges($request->permissions) );
break;
case 'SOME-DENIED-PROPERTY': /** TODO: indicating the style for future expansion */
case 'SOME-DENIED-PROPERTY': /** indicating the style for future expansion */
$denied[] = $v;
break;
default: