fix documentation issues

Author: sipma

CodeHawk/CH/chlib/cHNumerical.mli

@@ -138,7 +138,7 @@ val mkNumericalFromInt64 : int64 -> numerical_t
 val mkNumericalFromString: string -> numerical_t
 
 
-(** [mkNumericalPowerOf2 n] returns the numerical for 2^n] *)
+(** [mkNumericalPowerOf2 n] returns the numerical for [2^n] *)
 val mkNumericalPowerOf2: int -> numerical_t
 
 

CodeHawk/CH/chutil/cHPrettyUtil.mli

@@ -70,7 +70,7 @@ val fixed_length_int_string: string -> int -> string
 (** [string_suffix s n] returns the suffix of [s] that starts at the n'th
     character of [s] (zero-based).
 
-    @raise Invalid_argument if [n] is larger than the length of [s]
+    raise Invalid_argument if [n] is larger than the length of [s]
  *)
 val string_suffix: string -> int -> string
 

CodeHawk/CH/chutil/cHTraceResult.mli

@@ -34,12 +34,12 @@ type 'a traceresult = ('a, string list) result
 
 
 (** [tget_ok r] is [v] if [r] is [Ok v] and
-    @raise [Invalid_argument] otherwise.*)
+    raise [Invalid_argument] otherwise.*)
 val tget_ok: 'a traceresult -> 'a
 
 
 (** [tget_error r] is [e] if [r] is [Error e] and
-    @raise [Invalid_argument] otherwise.*)
+    raise [Invalid_argument] otherwise.*)
 val tget_error: 'a traceresult -> string list
 
 

CodeHawk/CHB/bchlib/bCHBCTypeUtil.mli

@@ -85,16 +85,16 @@ val t_charptr: btype_t
 val ptr_deref: btype_t -> btype_t
 
 
-(** {2 Array types)*)
+(** {2 Array types} *)
 
 val t_array: btype_t -> int -> btype_t
 
 
-(** {2 Type definition}*)
+(** {2 Type definition} *)
 
 val t_named: string -> btype_t
 
-(** {2 Composite types}*)
+(** {2 Composite types} *)
 
 val t_comp: ?name_space:string list -> string -> btype_t
 val t_enum: ?name_space:string list -> string -> btype_t

CodeHawk/CHB/bchlib/bCHBCTypes.mli

@@ -604,7 +604,7 @@ class type bcfiles_int =
 
     (** [get_varinfo name] returns the varinfo with name [name].
 
-        @raise BCH_failure if no varinfo exists with name [name].*)
+        raise BCH_failure if no varinfo exists with name [name].*)
     method get_varinfo: ?prefix:bool -> string -> bvarinfo_t
 
     (** Returns all global varinfos (including functions) *)
@@ -622,7 +622,7 @@ class type bcfiles_int =
     (** [get_typedef name] returns the (not necessarily fully expanded) type
         definition associated with [name].
 
-        @raise BCH_failure if no typedef exists with name [name].
+        raise BCH_failure if no typedef exists with name [name].
      *)
     method get_typedef: string -> btype_t
 
@@ -640,7 +640,7 @@ class type bcfiles_int =
     (** [get_compinfo key] returns the compinfo structure associated with
         (CIL-assigned) key [key].
 
-        @raise BCH_failure if no compinfo definition or declaration exists
+        raise BCH_failure if no compinfo definition or declaration exists
         with key [key].
      *)
     method get_compinfo: int -> bcompinfo_t
@@ -655,7 +655,7 @@ class type bcfiles_int =
 
     (** [get_enuminfo name] returns the enuminfo structure with name [name].
 
-        @raise BCH_failure if no enuminfo definition or declaration exists with
+        raise BCH_failure if no enuminfo definition or declaration exists with
         name [name]
      *)
     method get_enuminfo: string -> benuminfo_t

CodeHawk/CHB/bchlib/bCHBasicTypes.mli

@@ -40,6 +40,7 @@ open BCHLibTypes
 
 
 exception BCH_failure of pretty_t
+(** basic exception in all of CHB *)
 
 (* raised in cases an internal inconsistency is encountered *)
 exception Internal_error of string

CodeHawk/CHB/bchlib/bCHByteUtilities.mli

@@ -51,8 +51,8 @@ val rawdata_to_string:
 
 
 (** [write_xml_raw_data elt s dw] writes byte string [s] to the xml element
-    [elt] in the form of sub elements with tag {aline} and attributes
-    {bytes} and {print} that contain 4 space-separated groups of 4 bytes in
+    [elt] in the form of sub elements with tag [aline] and attributes
+    [bytes] and [print] that contain 4 space-separated groups of 4 bytes in
     hexadecimal and a print represenation of those 16 bytes, respectively.
 
     This format is used in saving binary content of the sections to xml.*)

CodeHawk/CHB/bchlib/bCHCPURegisters.mli

@@ -127,13 +127,13 @@ val full_registers: cpureg_t list
 (** [mk_arm_sp_reg i] returns an ARM single-precision floating point register
     (S<i>)
 
-    @raise BCH_failure if [i] is negative or i is greater than 31.*)
+    raise BCHBasicTypes.BCH_failure if [i] is negative or i is greater than 31.*)
 val mk_arm_sp_reg: int -> arm_extension_register_t
 
 (** [mk_arm_dp_reg i] returns an ARM double-precision floating point register
     (D<i>)
 
-    @raise BCH_failure if [i] is negative or i is greater than 15.*)
+    raise BCH_failure if [i] is negative or i is greater than 15.*)
 val mk_arm_dp_reg: int -> arm_extension_register_t
 
 

CodeHawk/CHB/bchlib/bCHConstantDefinitions.mli

@@ -76,7 +76,7 @@ val has_symbolic_address: string -> bool
 (** [get_symbolic_address name] returns the address associated with name
     [name].
 
-    @raise BCH_failure if no address exists with name [name].
+    raise BCH_failure if no address exists with name [name].
  *)
 val get_symbolic_address: string -> doubleword_int
 
@@ -96,20 +96,20 @@ val get_untyped_symbolic_address_names: unit -> string list
 val update_symbolic_address_btype: string -> btype_t -> unit
 
 (** [has_symbolic_address_name dw] returns true if the address [dw] is
-    associated with a name.]*)
+    associated with a name.*)
 val has_symbolic_address_name: doubleword_int -> bool
 
 (** [get_symbolic_address_name dw] returns the name associated with address
     [dw].
 
-    @raise BCH_failure if no name is associated with address [dw]
+    raise BCH_failure if no name is associated with address [dw]
  *)
 val get_symbolic_address_name: doubleword_int -> string
 
 (** [get_symbolic_address_type dw] returns the btype of the symbolic address
     associated with address value [dw].
 
-    @raise BCH_failure if no symbolic address is associated with address [dw].
+    raise BCH_failure if no symbolic address is associated with address [dw].
  *)
 val get_symbolic_address_type: doubleword_int -> btype_t
 

CodeHawk/CHB/bchlib/bCHDemangler.mli

@@ -36,7 +36,7 @@ open BCHLibTypes
 
 
 (**
-   {[
+{v
    ==============================================================================
    Grammar
    ==============================================================================
@@ -164,13 +164,13 @@ open BCHLibTypes
      U    struct
      V    class
      W    enum
-  ]}
+v}
 
   currently not supported yet:
     - fields
     - function pointers
 
- *)
+*)
 
 val demangle: string -> string
 val has_demangled_name: string -> bool