1 files changed, 79 insertions, 0 deletions
diff --git a/doc/libvformat-2.texi b/doc/libvformat-2.texi
new file mode 100644
index 0000000..0511a56
--- /dev/null
+++ b/doc/libvformat-2.texi
@@ -0,0 +1,79 @@
+@node Public structures
+@chapter Public structures
+     
+@defvr {Public Type} VF_PARSER_T
+
+Type representing "parser" - an object used to parse VOBJECTS.
+     
+@end defvr
+
+@defvr {Public Type} VF_OBJECT_T
+
+Type representing an "object" - objects are collections of properties.
+
+@end defvr
+
+@defvr {Public Type} VF_PROP_T
+
+Type representing a "property" - properties associate a name & a value.
+
+@end defvr
+
+@deftp {Structure} VF_ISO8601_PERIOD_T @*
+       @{@*
+       uint32_t    years@*
+       uint32_t    months@*
+       uint32_t    weeks@*
+       uint32_t    days@*
+       uint32_t    hours@*
+       uint32_t    minutes@*
+       uint32_t    seconds@*
+       @}
+
+
+VF_ISO8601_PERIOD_T is used to encapsulate an ISO time 'period'.
+
+@end deftp
+
+
+@deftypevr {Public Type} uint8_t vf_encoding_t
+
+vf_encoding_t enumerates the supported encodings (formats) of a
+vformat object property.  Each "value" has a field of this type.
+
+Predefined values
+
+@multitable     {VF_ENC_QUOTEDPRINTABLE}{((vf_encoding_t)aaaa}{123456}
+@item VF_ENC_UNKNOWN     @tab     ((vf_encoding_t)(0))
+@item VF_ENC_7BIT        @tab     ((vf_encoding_t)(1))
+@item VF_ENC_8BIT        @tab     ((vf_encoding_t)(2))
+@item VF_ENC_BASE64      @tab     ((vf_encoding_t)(3))
+@item VF_ENC_QUOTEDPRINTABLE  @tab ((vf_encoding_t)(4))
+@item VF_ENC_VOBJECT     @tab     ((vf_encoding_t)(5))
+@end multitable
+
+@end deftypevr
+
+
+@deftypevr {Public Type} uint16_t vf_get_t
+
+vf_get_t controls the operation of vf_get_property() (qv).  Controls
+how far the search algorithm is prepared to go in order to return a
+property ready for modification.
+
+Predefined values
+
+@multitable     {VF_ENC_QUOTEDPRINTABLE}{((vf_encoding_t)aaaa}{Find & append if not present123456}
+@item VFGP_FIND    @tab   ((vf_get_t)(0x0001))  @tab  Search for property            
+@item VFGP_APPEND  @tab   ((vf_get_t)(0x0002))  @tab  Append property, no search    
+@item VFGP_GET     @tab   ((vf_get_t)(0x0003))  @tab  Find & append if not present  
+@end multitable
+
+@end deftypevr
+
+@deftypevr {Public Type} uint32_t vf_search_flags_t
+
+vf_search_flags_t is used to describe how string matching is performed
+when searching for properties, qualifiers, values etc.
+
+@end deftypevr