update comments

OHNLP · May 11, 2023 · 76b4af9 · 76b4af9
1 parent 5c9b93d
commit 76b4af9
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 5 deletions.
diff --git a/templates/js/ann_parser.js b/templates/js/ann_parser.js
@@ -1,6 +1,8 @@
 /**
  * Annotation file parser
  * 
+ * This module is designed to read/write MedTator XML files.
+ * 
  * The ann used in this tool is an object following this format:
  * {
  *  _fh: FileSystemHandle,

diff --git a/templates/js/bioc_parser.js b/templates/js/bioc_parser.js
@@ -1,5 +1,8 @@
 /**
  * BioC format annotation file parser
+ * 
+ * For more information about this format,
+ * You can visit https://bioc.sourceforge.net/
  */
 var bioc_parser = {
 

diff --git a/templates/js/dtd_parser.js b/templates/js/dtd_parser.js
@@ -1,5 +1,9 @@
 /**
  * Annotation schema file parser
+ * 
+ * For more information about the annotation schema,
+ * Please check our wiki page: 
+ * https://github.com/OHNLP/MedTator/wiki/Annotation-Schema
  */
 var dtd_parser = {
     regex: {

diff --git a/templates/js/erp_toolkit.js b/templates/js/erp_toolkit.js
@@ -1,5 +1,12 @@
 /**
  * Easy Rule Pack Toolkit
+ * 
+ * For more information about the ruleset,
+ * Please visit MedTagger website: 
+ * https://github.com/OHNLP/MedTagger
+ * 
+ * And there are also some example rulesets:
+ * https://github.com/OHNLP/covid19ruleset
  */
 var erp_toolkit = {
     rp: {

diff --git a/templates/js/fig_bratvis.js b/templates/js/fig_bratvis.js
@@ -1,3 +1,10 @@
+/**
+ * A helper for visualization based on Brat
+ * 
+ * This helper is designed to show entities and relations
+ * in a brat-style, whcih is easier to view complex 
+ * connections between many entities.
+ */
 var fig_bratvis = {
     plot_id: 'fig_bratvis',
 

diff --git a/templates/js/fs_helper.js b/templates/js/fs_helper.js
@@ -1,6 +1,12 @@
-///////////////////////////////////////////////////////////
-// General purpose fs functions
-///////////////////////////////////////////////////////////
+/**
+ * Helper functions for reading and writing file system
+ * 
+ * These functions are based on HTML5 File System Access API
+ * Please ensure your target browser supports it.
+ * 
+ * For more information, please visit:
+ * https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API
+ */
 
 async function fs_open_files(pickerOpts) {
     const fhs = await window.showOpenFilePicker(pickerOpts);

diff --git a/templates/js/iaa_calculator.js b/templates/js/iaa_calculator.js
@@ -1,3 +1,7 @@
+/**
+ * IAA calculator for comparing corpus
+ */
+
 var iaa_calculator = {
     colors: {
         decision_agreed: '94d2bd',

diff --git a/templates/js/iob_helper.js b/templates/js/iob_helper.js
@@ -1,7 +1,7 @@
 /**
  * IOB2/BIO format helper
  * 
- * This is a helper for parse, analyze, and save IOB2/BIO format files.
+ * This is a helper to parse, analyze, and save IOB2/BIO format files.
  */
 var iob2_helper = {
     /**

diff --git a/templates/js/jarvis.js b/templates/js/jarvis.js
@@ -1,3 +1,8 @@
+/**
+ * A manager for all kinds of tasks that we don't want core app to do
+ * 
+ * Hey Jarvis! It's not a voice command assistant.
+ */
 var jarvis = {
     // for annotating test
     sample_text: {},

diff --git a/templates/js/medtagger_toolkit.js b/templates/js/medtagger_toolkit.js
@@ -1,6 +1,9 @@
 /**
  * MedTagger format annotation file parser
  * 
+ * For more information about the MedTagger,
+ * Please visit MedTagger website: 
+ * https://github.com/OHNLP/MedTagger
  */
  var medtagger_toolkit = {
      regex: {

diff --git a/templates/js/nlp_toolkit.js b/templates/js/nlp_toolkit.js
@@ -1,3 +1,7 @@
+/**
+ * A toolkit for NLP related tasks
+ */
+
 var nlp_toolkit = {
     sent_tlb_syms: ' `!@#$%^&*()_+-=[]{}|\\:";\'<>?,/',
     sentencize_exceptions: new Set([

diff --git a/templates/js/spacy_toolkit.js b/templates/js/spacy_toolkit.js
@@ -1,3 +1,6 @@
+/**
+ * A SpaCy toolkit for format conversion
+ */
 var spacy_toolkit = {
 
     download_anns_as_jsonl: function(anns, dtd, fn) {

diff --git a/templates/js/stat_helper.js b/templates/js/stat_helper.js
@@ -1,5 +1,5 @@
 /**
- * A helper object for the statistics related functions
+ * A helper for the statistics related functions
  */
 var stat_helper = {
     /**