Browse Source

Add some documentation.

Christian Egli 15 years ago
parent
commit
c012637555
2 changed files with 8 additions and 1 deletions
  1. 1 0
      lisp/ChangeLog
  2. 7 1
      lisp/org-taskjuggler.el

+ 1 - 0
lisp/ChangeLog

@@ -298,6 +298,7 @@
 	"task_id" instead as we do not search for ids across files.
 	"task_id" instead as we do not search for ids across files.
 	(org-taskjuggler-resolve-explicit-dependencies): Issue a warning
 	(org-taskjuggler-resolve-explicit-dependencies): Issue a warning
 	if a dependency cannot be resolved.
 	if a dependency cannot be resolved.
+	(org-taskjuggler-open-resource): Add documentation.
 
 
 2010-04-28  Carsten Dominik  <carsten.dominik@gmail.com>
 2010-04-28  Carsten Dominik  <carsten.dominik@gmail.com>
 
 

+ 7 - 1
lisp/org-taskjuggler.el

@@ -511,7 +511,7 @@ finally add more underscore characters (\"_\")."
   (and id (replace-regexp-in-string "[^a-zA-Z0-9_]" "_" id)))
   (and id (replace-regexp-in-string "[^a-zA-Z0-9_]" "_" id)))
 
 
 (defun org-taskjuggler-open-project (project)
 (defun org-taskjuggler-open-project (project)
-  "Insert a the beginning of project declaration. All valid
+  "Insert the beginning of a project declaration. All valid
 attributes from the PROJECT alist are inserted. If no end date is
 attributes from the PROJECT alist are inserted. If no end date is
 specified it is calculated
 specified it is calculated
 `org-export-taskjuggler-default-project-duration' days from now."
 `org-export-taskjuggler-default-project-duration' days from now."
@@ -555,6 +555,12 @@ If the ATTRIBUTE is not in ITEM return nil."
    (t (org-taskjuggler-get-attribute (cdr item) attribute))))
    (t (org-taskjuggler-get-attribute (cdr item) attribute))))
 
 
 (defun org-taskjuggler-open-resource (resource)
 (defun org-taskjuggler-open-resource (resource)
+  "Insert the beginning of a resource declaration. All valid
+attributes from the RESOURCE alist are inserted. If the RESOURCE
+defines a property \"resource_id\" it will be used as the id for
+this resource. Otherwise it will use the ID property. If neither
+is defined it will calculate a unique id for the resource using
+`org-taskjuggler-get-unique-id'."
   (let ((id (org-taskjuggler-clean-id 
   (let ((id (org-taskjuggler-clean-id 
 	     (or (cdr (assoc "resource_id" resource)) 
 	     (or (cdr (assoc "resource_id" resource)) 
 		 (cdr (assoc "ID" resource)) 
 		 (cdr (assoc "ID" resource))