Generation of auxiliary lemmas for inductive types and records moved

[helm.git] / helm / ocaml / library / librarySync.mli

diff --git a/helm/ocaml/library/librarySync.mli b/helm/ocaml/library/librarySync.mli
index 0e0916e4dd61d8f7e70d8ae0adfbb8337cb0022f..89262e39390dd32d6ab5452162a5bb557523eeac 100644 (file)
--- a/helm/ocaml/library/librarySync.mli
+++ b/helm/ocaml/library/librarySync.mli
@@ -23,9 +23,12 @@
  * http://helm.cs.unibo.it/
  *)
 
-(* returns a list of added URIs and their paths on disk *)
-(*CSC: the path on disk should be computable from the URI!!! *)
-val add_obj: UriManager.uri -> Cic.obj -> basedir:string -> unit
+(* adds an object to the library together with all auxiliary lemmas on it *)
+(* (e.g. elimination principles, projections, etc.)                       *)
+(* it returns the list of the uris of the auxiliary lemmas generated      *)
+val add_obj: UriManager.uri -> Cic.obj -> basedir:string -> UriManager.uri list
 
-(* inverse of add_obj; it does not remove the objects depending on it! *)
+(* inverse of add_obj;                                                   *)
+(* Warning: it does not remove the dependencies on the object and on its *)
+(* auxiliary lemmas!                                                     *)
 val remove_obj: UriManager.uri -> unit