Initial revision
This commit is contained in:
slidedraw
1
cole/doc/tmpl/.cvsignore
Normal file
1
cole/doc/tmpl/.cvsignore
Normal file
@@ -0,0 +1 @@
|
||||
*.bak
|
||||
434
cole/doc/tmpl/api.sgml
Normal file
434
cole/doc/tmpl/api.sgml
Normal file
@@ -0,0 +1,434 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
API
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Public cole API for the present release.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Note: The separator character for filename components is '/'. So, a filename argument can be something like "/Macros/VB/Project1".
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO COLE_MAJOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COLE_MINOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO COLE_MICRO_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_major_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_minor_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_micro_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_version ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE cole_host_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM COLERRNO ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_perror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
@colerrno:
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIRENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_mount ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_umount ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_print_tree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_locate_filename ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@filename:
|
||||
@info:
|
||||
@action:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_recurse_tree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@info:
|
||||
@inroot:
|
||||
@indirentry:
|
||||
@indir:
|
||||
@outdir:
|
||||
@visitdir:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fopen ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@filename:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fopen_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@colefilesystem:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fclose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fread ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@ptr:
|
||||
@size:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_feof ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_ftell ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_fseek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@delta:
|
||||
@direction:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_frewind ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_opendir_rootdir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_opendir_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_closedir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_visiteddirentry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_nextdirentry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_isdir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_isfile ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsec1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getsec2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getdays1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_dir_getdays2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getname ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getdays1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsec1 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getdays2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry_getsec2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledirentry:
|
||||
@Returns:
|
||||
|
||||
|
||||
75
cole/doc/tmpl/cole-unused.sgml
Normal file
75
cole/doc/tmpl/cole-unused.sgml
Normal file
@@ -0,0 +1,75 @@
|
||||
<!-- ##### FUNCTION cole_opendir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefilesystem:
|
||||
@colerrno:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION OLEcode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@OLEfilename:
|
||||
@trunc:
|
||||
@stream_list:
|
||||
@root:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION freeOLEtree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@tree:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_ferror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_direntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@coledir:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION verbosePPSTree ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pps_list:
|
||||
@root_pps:
|
||||
@level:
|
||||
|
||||
<!-- ##### FUNCTION OLEdecode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@OLEfilename:
|
||||
@stream_list:
|
||||
@root:
|
||||
@_BDepot:
|
||||
@_SDepot:
|
||||
@_sbfile:
|
||||
@_input:
|
||||
@max_level:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION cole_fclearerror ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@colefile:
|
||||
|
||||
284
cole/doc/tmpl/internals.sgml
Normal file
284
cole/doc/tmpl/internals.sgml
Normal file
@@ -0,0 +1,284 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Internals
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
cole internals - don't trust in anything here, because it may (and will) change.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Contains calls to access directly the file system, and endianess care calls.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT COLEFS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIRENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEDIR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT COLEFILE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO F32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO F64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO U32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_sreadF64 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@in:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_swriteU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION fil_swriteU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@dest:
|
||||
@src:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_return ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO test ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@retval:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_exitf ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@retval:
|
||||
@func:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_call ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@typeretval:
|
||||
|
||||
|
||||
<!-- ##### MACRO test_call_exitf ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
@typeretval:
|
||||
@func:
|
||||
|
||||
|
||||
<!-- ##### MACRO report_bug ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@prog:
|
||||
|
||||
|
||||
<!-- ##### MACRO assert_return ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@prog:
|
||||
@t:
|
||||
@retval:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_d ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@n:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
|
||||
|
||||
<!-- ##### MACRO verbose_wonl ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@s:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU16 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU32 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseS_wonl ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@expr:
|
||||
|
||||
|
||||
<!-- ##### MACRO warning ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@t:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU32Array ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@len:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8Array_force ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@rec:
|
||||
@len:
|
||||
@reclen:
|
||||
|
||||
|
||||
<!-- ##### MACRO verboseU8Array ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@rec:
|
||||
@len:
|
||||
@reclen:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user