X-Authentication-Warning: delorie.com: mail set sender to geda-user-bounces using -f
X-Recipient: geda-user AT delorie DOT com
X-Mailer: exmh version 2.7.2 01/07/2005 (debian 1:2.7.2-18) with nmh-1.3
X-Exmh-Isig-CompType: repl
X-Exmh-Isig-Folder: inbox
To: geda-user AT delorie DOT com
Subject: Re: [geda-user] libgeda documentation (was: New dev)
In-reply-to: <50A2E0FC.5050108@sbcglobal.net>
References: <20121113195022 DOT 2B2CF813A49B AT turkos DOT aspodata DOT se> <50A2E0FC DOT 5050108 AT sbcglobal DOT net>
Comments: In-reply-to "Girvin R. Herr" <girvin DOT herr AT sbcglobal DOT net>
   message dated "Tue, 13 Nov 2012 16:08:28 -0800."
Mime-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Message-Id: <20121114090659.BF2CF813A49D@turkos.aspodata.se>
Date: Wed, 14 Nov 2012 10:06:59 +0100 (CET)
From: karl AT aspodata DOT se (Karl Hammar)
X-Virus-Scanned: ClamAV using ClamSMTP
Reply-To: geda-user AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: geda-user AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk

Girvin Herr:
...
> A while back on this forum, I asked if there was an API document that
> explains the libgeda functions and their inputs (arguments) and
> output(s).

If you downloaded the source and built the suite, you can look into

 <geda-gaf source dir>/libgeda/docs/html/index.html

you'll find what you are asking for. It is incomplete but it is there.

If you click on "File list" in the left frame and then on "a_basic.c",
and then on "o_save", you'll find:

====
int o_save 	( 	TOPLEVEL *  	toplevel,
		GList *  	object_list,
		char *  	filename	 
	) 			

Function Description
    This function saves the data in a libgeda format to a file 

Parameters:
    [in] 	toplevel 	The current TOPLEVEL.
    [in] 	object_list 	The head of a GList of OBJECTs to save.
    [in] 	filename 	The filename to save the data to.

Returns:
    1 on success, 0 on failure.
====

Yes, it would be nice if one could click on "object_list" to find
out what that is.

///

Is it anybody using this?
Should we try to include documentation for scheme routines also?
Is this the kind of documentation one wants ?

Comments

Regards,
/Karl Hammar

-----------------------------------------------------------------------
Aspö Data
Lilla Aspö 148
S-742 94 Östhammar
Sweden
+46 173 140 57