From e510dbd4ea616262a7313a1a2715076b0ca70b62 Mon Sep 17 00:00:00 2001
From: mazze <mazze@fb15a70f-31f2-0310-bbcc-cdcc74a49acc>
Date: Sat, 4 Oct 2008 12:51:02 +0000
Subject: [PATCH] Autodocs updated.

git-svn-id: https://svn.aros.org/svn/aros/trunk/AROS@29667 fb15a70f-31f2-0310-bbcc-cdcc74a49acc
---
 workbench/libs/icon/changetoselectediconcolor.c |  4 +++-
 workbench/libs/icon/drawiconstate.c             | 14 +++++++++++---
 workbench/libs/icon/getdiskobject.c             |  5 ++++-
 workbench/libs/icon/geticonrectangle.c          |  9 ++++++++-
 workbench/libs/icon/geticontaglist.c            |  2 +-
 workbench/libs/icon/iconcontrol.c               |  5 ++++-
 workbench/libs/icon/layouticon.c                |  4 +++-
 workbench/libs/icon/newdiskobject.c             |  6 +++++-
 workbench/libs/icon/putdiskobject.c             | 10 +++++++---
 9 files changed, 46 insertions(+), 13 deletions(-)

diff --git a/workbench/libs/icon/changetoselectediconcolor.c b/workbench/libs/icon/changetoselectediconcolor.c
index 348d3cb5d..5ad13630e 100644
--- a/workbench/libs/icon/changetoselectediconcolor.c
+++ b/workbench/libs/icon/changetoselectediconcolor.c
@@ -25,8 +25,10 @@
         struct Library *, IconBase, 33, Icon)
 
 /*  FUNCTION
-
+	Change a color register for selected icon state.
+	
     INPUTS
+	cr - colorregister to be changed.
 
     RESULT
 
diff --git a/workbench/libs/icon/drawiconstate.c b/workbench/libs/icon/drawiconstate.c
index 0fb9109e4..4ec652447 100644
--- a/workbench/libs/icon/drawiconstate.c
+++ b/workbench/libs/icon/drawiconstate.c
@@ -27,19 +27,27 @@
 	struct Library *, IconBase, 27, Icon)
 
 /*  FUNCTION
-
+	Draw an icon like an image.
+	
     INPUTS
-
+	rp       - rastport to draw into
+	icon     - the icon
+	label    - label string
+	leftEdge, 
+	topEdge  - drawing position 
+	state    - drawing state, see intuition/imageclass.h
+    
     RESULT
 
     NOTES
+	Only very limited implemented.
 
     EXAMPLE
 
     BUGS
 
     SEE ALSO
-	AddFreeList()
+	intuition/imageclass.h
 
     INTERNALS
 
diff --git a/workbench/libs/icon/getdiskobject.c b/workbench/libs/icon/getdiskobject.c
index 272eda4d1..f3377fb3e 100644
--- a/workbench/libs/icon/getdiskobject.c
+++ b/workbench/libs/icon/getdiskobject.c
@@ -20,10 +20,13 @@
 	struct Library *, IconBase, 13, Icon)
 
 /*  FUNCTION
-
+	Opens an icon from disk.
+	
     INPUTS
+	name - filename without ".info" or NULL for an empty diskobject.
 
     RESULT
+	Pointer to diskobject.
 
     NOTES
 
diff --git a/workbench/libs/icon/geticonrectangle.c b/workbench/libs/icon/geticonrectangle.c
index 45af64508..77d9f2a57 100644
--- a/workbench/libs/icon/geticonrectangle.c
+++ b/workbench/libs/icon/geticonrectangle.c
@@ -22,12 +22,19 @@
 	struct Library *, IconBase, 28, Icon)
 
 /*  FUNCTION
-
+	Query size of icon.
+	
     INPUTS
+	rp        - reference RastPort (for font)
+	icon      - icon to be queried
+	label     - label string
+	rectangle - resulting size
 
     RESULT
+	TRUE success
 
     NOTES
+	Only very limited implemented.
 
     EXAMPLE
 
diff --git a/workbench/libs/icon/geticontaglist.c b/workbench/libs/icon/geticontaglist.c
index cfd6f5d9c..6c4acd060 100644
--- a/workbench/libs/icon/geticontaglist.c
+++ b/workbench/libs/icon/geticontaglist.c
@@ -24,7 +24,7 @@
 	struct Library *, IconBase, 30, Icon)
 
 /*  FUNCTION
-
+	Open icon from disk
     INPUTS
 
     TAGS
diff --git a/workbench/libs/icon/iconcontrol.c b/workbench/libs/icon/iconcontrol.c
index b0a6ac420..e6ef89c07 100644
--- a/workbench/libs/icon/iconcontrol.c
+++ b/workbench/libs/icon/iconcontrol.c
@@ -26,10 +26,13 @@
         struct Library *, IconBase, 26, Icon)
 
 /*  FUNCTION
-
+	Set and get icon and icon.library options.
+	
     INPUTS
+	icon - icon to be queried
 
     RESULT
+	Number of processed tags.
 
     NOTES
 
diff --git a/workbench/libs/icon/layouticon.c b/workbench/libs/icon/layouticon.c
index 5e48281a5..7a003500b 100644
--- a/workbench/libs/icon/layouticon.c
+++ b/workbench/libs/icon/layouticon.c
@@ -27,12 +27,14 @@
         struct Library *, IconBase, 32, Icon)
 
 /*  FUNCTION
-
+	Adapt a palette-mapped icon for display.
+	
     INPUTS
 
     RESULT
 
     NOTES
+	Not implemented.
 
     EXAMPLE
 
diff --git a/workbench/libs/icon/newdiskobject.c b/workbench/libs/icon/newdiskobject.c
index 4fac0ff14..b01657c87 100644
--- a/workbench/libs/icon/newdiskobject.c
+++ b/workbench/libs/icon/newdiskobject.c
@@ -24,12 +24,16 @@
         struct Library *, IconBase, 29, Icon)
 
 /*  FUNCTION
-
+	Create empty diskobject structure.
+	
     INPUTS
+	type - WBDISK, WBDRAWER, WBTOOL, WBPROJECT,
+	       WBGARBAGE, WBDEVICE or WBKICK
 
     RESULT
 
     NOTES
+	Not implemented.
 
     EXAMPLE
 
diff --git a/workbench/libs/icon/putdiskobject.c b/workbench/libs/icon/putdiskobject.c
index 6395f44f0..566ad20f2 100644
--- a/workbench/libs/icon/putdiskobject.c
+++ b/workbench/libs/icon/putdiskobject.c
@@ -20,11 +20,15 @@
 	struct Library *, IconBase, 14, Icon)
 
 /*  FUNCTION
-
+	Writes icon to disk.
+	
     INPUTS
-
+	name - filename, ".info" will be appended.
+	icon - diskobject to write
+	
     RESULT
-
+	TRUE on success, FALSE on error
+	
     NOTES
 
     EXAMPLE
-- 
2.11.4.GIT