From c01263755592b77518bfbb3be14ce1181ff977ab Mon Sep 17 00:00:00 2001 From: Christian Egli Date: Wed, 28 Apr 2010 09:14:43 +0200 Subject: [PATCH] Add some documentation. --- lisp/ChangeLog | 1 + lisp/org-taskjuggler.el | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 5000f2f4e..907f72485 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 diff --git a/lisp/org-taskjuggler.el b/lisp/org-taskjuggler.el index f29251348..469b6ee2c 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))