8ba9695dd0a51b772a5a0f826027f313d7c3d21a
angie
  Fri Jan 23 14:21:11 2015 -0800
Added header comments as suggested by Kate.  refs #14698
diff --git src/hg/hgAi/hgAi.c src/hg/hgAi/hgAi.c
index 7a7693d..d15ddaf 100644
--- src/hg/hgAi/hgAi.c
+++ src/hg/hgAi/hgAi.c
@@ -1,16 +1,26 @@
-/* hgAi - General annotation integrator interface. */
+/* hgAi - bootstrapper / back end for the Annotation Integrator user interface
+ * This CGI has three modes of operation:
+ *  - HTML output for minimal main page with a <div> container to be filled in by javascript
+ *    (default, in the absence of special CGI params)
+ *  - JSON responses to ajax requests from javascript (using hg/lib/cartJson.c)
+ *    (if CGI param CARTJSON_COMMAND exists)
+ *  - text output for annoGrator queries on track data
+ *    (if CGI param DO_QUERY exists)
+ * The UI view top level is in ../js/react/hgAi/hgAi.jsx
+ * The UI model top level is in ../js/model/hgAi/hgAiModel.js
+ */
 #include "common.h"
 #include "cart.h"
 #include "cartJson.h"
 #include "cartTrackDb.h"
 #include "cheapcgi.h"
 #include "hAnno.h"
 #include "hCommon.h"
 #include "hdb.h"
 #include "hgColors.h"
 #include "hui.h"
 #include "jsonParse.h"
 #include "textOut.h"
 #include "trackHub.h"
 #include "web.h"
 #include "annoFormatTab.h"