Commits

cacol89 committed f526d8d

Changed headers in files. Fixed some documentation issues.

Comments (0)

Files changed (8)

 * PostgreSQL (>= 9.0)
 * postgresql-ocaml (>=2.0.1) 
 * findlib (>= 1.3.1)
+* GNU Make (>= 3.81)
 
 Installing
 ==========
  *   performed with a db-connection, such as fetching columns
  *   or printing the results
  *   
- *   @author cruelcoderz
- * 
  *)
 (********************************************************)
 
 open Expr;;
 
 (** Extract response column-names and tuples to lists 
- *  @param res_to_lst is the provided list of column_names
- *  @return empty_query, tuples_ok or error messages in case of problems *)
+ *  Returns: empty_query, tuples_ok or error messages in case of problems *)
 let res_to_lst conn res =
     match res#status with
   | Empty_query -> ([],[])
 (*******************************************************)
 (**  eval.ml
  *
- *   AST processing functions are defined here, 
- *   including sql_stt
+ *   AST-to-SQL functions are defined here.
  *   
- *   @author cruelcoderz
- * 
  *)
 (********************************************************)
 
 (*******************************************************)
 (**  expr.ml
  *
- *   base type for the Abstract Syntax Tree of the rule-based language.
+ *   Abstract Syntax Tree definition of the rule-based language.
  *   Allows later semantical processing of any kind, such like for instance,
  *   checking consistency, safety or satisfiability, evaluating, printing, etc.
  *   
- *   @author cruelcoderz
- * 
+ *   This file also contains accessor functions to the ASTs and
+ *   some check/transformation functions. 
  *)
 (********************************************************)
 
         List.fold_left extract_rterm [] t
     | Query _    -> invalid_arg "function get_all_rule_rterms called with a query"
 
+(** Given an equality, returns the (var,const) tuple that defines it *)
 let extract_eq_tuple = function
     | Equal (v,c) -> (v,c)
     | _ -> invalid_arg "function extract_eq_tuple called without an equality"
 
+(** Given an inequality, returns the (op,var,const) tuple that defines it *)
 let extract_ineq_tuple = function
     | Ineq (s,v,c) -> (s,v,c)
     | _ -> invalid_arg "function extract_ineq_tuple called without an inequality"
 
+(** Given an aggregated variable, returns the (function_name,var_name) tuple that defines it *)
 let extract_aggvar_tuple = function
     | AggVar (fn,vn) -> (fn,vn)
     | _ -> invalid_arg "function extract_aggvar_tuple called without an aggregated var"
     | Ineq (">=",v,c) -> Ineq ("<",v,c)
     | _ -> invalid_arg "function negate_eq called without an equation"
 
+(** Returns true if the provided argument is an aggregate variable *)
 let is_aggvar = function
     | AggVar _ -> true
     | _ -> false
 
+(** Returns true if the provided argument is an equality involving an
+aggregate function*)
 let is_agg_equality = function
     | Equal (AggVar _ , _ ) -> true
     | Equal _ -> false
     | _ -> invalid_arg "function is_agg_equality called without an equality"
 
+(** Returns true if the provided argument is an inequality involving an
+aggregate function*)
 let is_agg_inequality = function
     | Ineq (_ , AggVar _ , _) -> true
     | Ineq _ -> false
  *
  *   Execution of YADI from command line, connection info
  *   help printouts for command line usage etc.
- *   
- *   @author cruelcoderz
  * 
  *)
 (********************************************************)

src/rule_preproc.ml

  *   Functions for preprocesing of IDB rules before
  *   SQL generation.
  *
- *   @author cruelcoderz
- * 
  *)
 (********************************************************)
 

src/stratification.ml

  *   and it will fail if the program is incomplete: if
  *   it contains references to undefined predicates.
  *
- *   @author cruelcoderz
- * 
  *)
 (********************************************************)
 

src/yadi_utils.ml

  *   This file contains data structure definitions and operations
  *   that are used along the program for different purposes.
  *   
- *   @author cruelcoderz
- * 
  *)
 (********************************************************)
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.