Changes between Version 1 and Version 2 of Registry2Notes

Timestamp:

Mar 23, 2009, 9:44:11 PM (15 years ago)

Author:

blb@…

Comment:

--

Registry2Notes

@@ -2 +2 @@
 Note that some source files have doxygen-style comments, so some docs can be created by running doxygen on them.
 
+Code: [browser:trunk/base/src/registry2.0]
+
 == Tcl commands created == #tcl_commands
  - `registry::entry cmd ?arg ...?`
-  - Run a command against registry entries
- - `${entry} cmd ?arg ...?`
-  - Commands specific to just one registry entry (usually gained from `registry::entry`)
- - `item cmd ?arg ...?`
- - `${item} cmd ?arg ...?`
- - `registry::open`
- - `registry::close`
- - `registry::read`
- - `registry::write`
-
-== C code files == #c_code
-=== entry.[ch] === #entry_c
- - void delete_entry(ClientData clientData)
-  - to be used as the 'Tcl_CmdDeleteProc' for an entry object
- - int entry_cmd(ClientData clientData UNUSED, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
-  - implements "registry::entry cmd ?arg ...?"
-  - commands are:
+  - Run a command against registry entries (implemented in entry.c)
+  - Commands are:
    - create - entry_create()
    - delete - entry_delete()
@@ -31 +18 @@
    - owner - entry_owner()
 
-=== entryobj.[ch] === #entryobj_c
- - int entry_obj_cmd(ClientData clientData, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
-  - implements "${entry} cmd ?arg ...?" (procs for entry objects from "registry::entry")
-  - commands are:
+ - `${entry} cmd ?arg ...?`
+  - Commands specific to just one registry entry (usually gained from `registry::entry`) (implemented in entryobj.c)
+  - Commands are:
    - name - entry_obj_prop()
    -  portfile - entry_obj_prop()
@@ -57 +43 @@
    -  depends - entry_obj_depends()
 
+ - `item cmd ?arg ...?`
+  - Implemented in item.c
+  - Commands are:
+   - create - item_create()
+   -  search - item_search()
+   -  exists - item_exists()
+   -  others are commented-out (retain, release, name, url, path, worker, options, and variants)
+
+ - `${item} cmd ?arg ...?`
+  - Implemented in itemobj.c
+  - Commands are:
+   - retain - item_obj_retain()
+   - release - item_obj_release()
+   - key - item_obj_key()
+
+ - Top-level registry commands (implemented in registry.c):
+   - registry::open - registry_open()
+   - registry::close - registry_close()
+   - registry::read - registry_read()
+   - registry::write - registry_write()
+   - registry::entry - entry_cmd()
+
+== C code files == #c_code
+=== entry.[ch] === #entry_c
+ - void delete_entry(ClientData clientData)
+  - to be used as the 'Tcl_CmdDeleteProc' for an entry object
+ - int entry_cmd(ClientData clientData UNUSED, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
+  - implements "registry::entry cmd ?arg ...?"
+
+=== entryobj.[ch] === #entryobj_c
+ - int entry_obj_cmd(ClientData clientData, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
+  - implements "${entry} cmd ?arg ...?" (procs for entry objects from "registry::entry")
+
 === graph.[ch] === #graph_c
 === graphobj.[ch] === #graphobj_c
@@ -64 +83 @@
  - int item_cmd(ClientData clientData UNUSED, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
   - implements "item cmd ?arg ...?"
-  - commands are:
-   - create - item_create()
-   -  search - item_search()
-   -  exists - item_exists()
-   -  others are commented-out (retain, release, name, url, path, worker, options, and variants)
 
 === itemobj.[ch] === #itemobj_c
  - int item_obj_cmd(ClientData clientData, Tcl_Interp* interp, int objc, Tcl_Obj* CONST objv[])
   - implements "${item} cmd ?arg ...?" (procs for item objects from "item"
-  - commands are:
-   - retain - item_obj_retain()
-   - release - item_obj_release()
-   - key - item_obj_key()
 
 === registry.[ch] === #registry_c
@@ -84 +94 @@
   - Sets a Tcl object result based on errPtr
  - int Registry_Init(Tcl_Interp* interp)
-  - The Tcl entry point for registry2.0; creates several commands:
-   - registry::open - registry_open()
-   - registry::close - registry_close()
-   - registry::read - registry_read()
-   - registry::write - registry_write()
-   - registry::entry - entry_cmd()
 
 === util.[ch] === #util_c