From db53b06b18f201042527996171b38081a46b9411 Mon Sep 17 00:00:00 2001
From: Uwe Steinmann <steinm@debian.org>
Date: Wed, 10 Apr 2013 15:39:50 +0200
Subject: [PATCH] add documtation for getDocumentLink() and getDocumentLinks()

---
 SeedDMS_Core/Core/inc.ClassDocument.php | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/SeedDMS_Core/Core/inc.ClassDocument.php b/SeedDMS_Core/Core/inc.ClassDocument.php
index 595ecbd61..f50d78cbf 100644
--- a/SeedDMS_Core/Core/inc.ClassDocument.php
+++ b/SeedDMS_Core/Core/inc.ClassDocument.php
@@ -1409,6 +1409,13 @@ class SeedDMS_Core_Document extends SeedDMS_Core_Object { /* {{{ */
 		return true;
 	} /* }}} */
 
+	/**
+	 * Return a certain document link
+	 *
+	 * @param integer $linkID id of link
+	 * @return object instance of SeedDMS_Core_DocumentLink or false in case of
+	 *         an error.
+	 */
 	function getDocumentLink($linkID) { /* {{{ */
 		$db = $this->_dms->getDB();
 
@@ -1425,6 +1432,15 @@ class SeedDMS_Core_Document extends SeedDMS_Core_Object { /* {{{ */
 		return new SeedDMS_Core_DocumentLink($resArr["id"], $document, $target, $resArr["userID"], $resArr["public"]);
 	} /* }}} */
 
+	/**
+	 * Return all document links
+	 *
+	 * The list contains all links to other documents, even those which
+	 * may not be visible certain users. The application should call
+	 * SeedDMS_Core_DMS::filterDocumentLinks() afterwards.
+	 *
+	 * @return array list of objects of class SeedDMS_Core_DocumentLink
+	 */
 	function getDocumentLinks() { /* {{{ */
 		if (!isset($this->_documentLinks)) {
 			$db = $this->_dms->getDB();