Atom

Check-in [28f13658ff]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Beginnings of documentation.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 28f13658ff6cec69c7d0c3ce5ccf4f5c00731728
User & Date: andreask 2013-05-10 22:53:35.896
Context
2013-10-18
23:03
Build tweak, added kettle references. check-in: 779e5d1ce3 user: andreask tags: trunk
2013-05-10
22:53
Beginnings of documentation. check-in: 28f13658ff user: andreask tags: trunk
2013-05-07
21:44
Brought completed testsuite restructuring back to main. check-in: d059eb2d35 user: andreask tags: trunk
Changes
Unified Diff Ignore Whitespace Patch
Added doc/API.txt.


























































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

Classes			Notes		Constructor arguments
-------			-----		----------------------
	atom		Virtual base
	atom::memory	In-memory	none
	atom::sqlite	Database	sqlite database + table name
	atom::cache			backend atom instance to cache
-------			-----		----------------------

API	Name		Arguments		Results
---	----		---------		-------
	id		string		 -->	id
	str		id		 -->	string
	names		()		 -->	list (string)
	exists		string		 -->	boolean
	exists-id	id		 -->	boolean
	size		()		 -->	integer
	map		string id	 -->	()
	clear		()		 -->	()
	serialize	()		 -->	dict (string -> id)
	deserialize	dict (str -> id) -->	()
	load		dict (str -> id) -->	()
	merge		dict (str -> id) -->	()
---	----		---------		-------

	<--	<==>	deserialize	(in)
	-->	<==>	serialize	(out)
	:=	<==>	load
	+=	<==>	merge