Peter M. Groen / knowledgetree

Commit 885c3503b3ac87796ae0d3bde72a04eee2b24a93

Authored by Kevin Fourie
1 parent b45254b4

Various PHPDoc fixes. 

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@9731 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 2 changed files with 18 additions and 14 deletions
ktapi/KTAPIConstants.inc.php
  View file @885c350
@@ -40,10 +40,12 @@ @@ -40,10 +40,12 @@
40 * @version Version 0.9 40 * @version Version 0.9
41 */ 41 */
42 42
43 -// Generic error messages used in the API. There may be some others specific to functionality  
44 -// directly in the code.  
45 -// TODO: Check that they are all relevant.  
46 - 43 +/**
  44 + * Generic error messages used in the API. There may be some others specific to functionality
  45 + * directly in the code.
  46 + *
  47 + * TODO: Check that they are all relevant.
  48 +*/
47 define('KTAPI_ERROR_SESSION_INVALID', 'The session could not be resolved.'); 49 define('KTAPI_ERROR_SESSION_INVALID', 'The session could not be resolved.');
48 define('KTAPI_ERROR_PERMISSION_INVALID', 'The permission could not be resolved.'); 50 define('KTAPI_ERROR_PERMISSION_INVALID', 'The permission could not be resolved.');
49 define('KTAPI_ERROR_FOLDER_INVALID', 'The folder could not be resolved.'); 51 define('KTAPI_ERROR_FOLDER_INVALID', 'The folder could not be resolved.');
@@ -59,15 +61,18 @@ define('KTAPI_ERROR_WORKFLOW_INVALID', 'The workflow could not be resolved.') @@ -59,15 +61,18 @@ define('KTAPI_ERROR_WORKFLOW_INVALID', 'The workflow could not be resolved.')
59 define('KTAPI_ERROR_WORKFLOW_NOT_IN_PROGRESS', 'The workflow is not in progress.'); 61 define('KTAPI_ERROR_WORKFLOW_NOT_IN_PROGRESS', 'The workflow is not in progress.');
60 define('KTAPI_ERROR_DOCUMENT_LINK_TYPE_INVALID','The link type could not be resolved.'); 62 define('KTAPI_ERROR_DOCUMENT_LINK_TYPE_INVALID','The link type could not be resolved.');
61 63
62 -// Mapping of permissions to actions.  
63 -// TODO: Check that they are all correct.  
64 -// Note, currently, all core actions have permissions that are defined in the plugins.  
65 -// As the permissions are currently associated with actions which are quite closely linked  
66 -// to the web interface, it is not the nicest way to do things. They should be associated at  
67 -// a lower level, such as in the api. probably, better, would be at some stage to assocate  
68 -// the permissions to the action/transaction in the database so administrators can really customise  
69 -// as required.  
70 - 64 +/**
  65 + * Mapping of permissions to actions.
  66 + *
  67 + * Note, currently, all core actions have permissions that are defined in the plugins.
  68 + * As the permissions are currently associated with actions which are quite closely linked
  69 + * to the web interface, it is not the nicest way to do things. They should be associated at
  70 + * a lower level, such as in the api. probably, better, would be at some stage to assocate
  71 + * the permissions to the action/transaction in the database so administrators can really customise
  72 + * as required.
  73 + *
  74 + * TODO: Check that they are all correct.
  75 +*/
71 define('KTAPI_PERMISSION_DELETE', 'ktcore.permissions.delete'); 76 define('KTAPI_PERMISSION_DELETE', 'ktcore.permissions.delete');
72 define('KTAPI_PERMISSION_READ', 'ktcore.permissions.read'); 77 define('KTAPI_PERMISSION_READ', 'ktcore.permissions.read');
73 define('KTAPI_PERMISSION_WRITE', 'ktcore.permissions.write'); 78 define('KTAPI_PERMISSION_WRITE', 'ktcore.permissions.write');
ktapi/KTAPIFolder.inc.php
  View file @885c350
@@ -1081,7 +1081,6 @@ class KTAPI_Folder extends KTAPI_FolderItem @@ -1081,7 +1081,6 @@ class KTAPI_Folder extends KTAPI_FolderItem
1081 * 1081 *
1082 * @author KnowledgeTree Team 1082 * @author KnowledgeTree Team
1083 * @access public 1083 * @access public
1084 - * @access public  
1085 * @return array 1084 * @return array
1086 */ 1085 */
1087 function get_permissions() 1086 function get_permissions()