summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Egli <christian.egli@alumni.ethz.ch>2010-04-28 09:14:43 +0200
committerChristian Egli <christian.egli@alumni.ethz.ch>2010-06-08 09:20:33 +0200
commitc01263755592b77518bfbb3be14ce1181ff977ab (patch)
treebd5d80ffafd402a267f3b03a91c6faefaf7f66d8
parent68068aa661fa2e19dbf4bb79a2ef801827d77109 (diff)
downloadorg-mode-c01263755592b77518bfbb3be14ce1181ff977ab.tar.gz
Add some documentation.
-rw-r--r--lisp/ChangeLog1
-rw-r--r--lisp/org-taskjuggler.el8
2 files changed, 8 insertions, 1 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 5000f2f..907f724 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -298,6 +298,7 @@
"task_id" instead as we do not search for ids across files.
(org-taskjuggler-resolve-explicit-dependencies): Issue a warning
if a dependency cannot be resolved.
+ (org-taskjuggler-open-resource): Add documentation.
2010-04-28 Carsten Dominik <carsten.dominik@gmail.com>
diff --git a/lisp/org-taskjuggler.el b/lisp/org-taskjuggler.el
index f292513..469b6ee 100644
--- a/lisp/org-taskjuggler.el
+++ b/lisp/org-taskjuggler.el
@@ -511,7 +511,7 @@ finally add more underscore characters (\"_\")."
(and id (replace-regexp-in-string "[^a-zA-Z0-9_]" "_" id)))
(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
specified it is calculated
`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))))
(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
(or (cdr (assoc "resource_id" resource))
(cdr (assoc "ID" resource))