From 609701961ec195c91bd81a80ee22593132c43bd9 Mon Sep 17 00:00:00 2001 From: Peter 'Pita' Martischka Date: Sun, 4 Dec 2011 15:33:56 +0000 Subject: [PATCH] Added some comments to help us documentating the code --- node/utils/Changeset.js | 6 ++++++ static/js/ace.js | 6 ++++++ static/js/ace2_common.js | 8 +++++++- static/js/ace2_inner.js | 6 ++++++ static/js/broadcast.js | 6 ++++++ static/js/broadcast_revisions.js | 6 ++++++ static/js/broadcast_slider.js | 6 ++++++ static/js/changesettracker.js | 6 ++++++ static/js/chat.js | 8 +++++++- static/js/collab_client.js | 6 ++++++ static/js/colorutils.js | 6 ++++++ static/js/contentcollector.js | 6 ++++++ static/js/cssmanager.js | 6 ++++++ static/js/cssmanager_client.js | 6 ++++++ static/js/domline.js | 6 ++++++ static/js/domline_client.js | 6 ++++++ static/js/draggable.js | 6 ++++++ static/js/easysync2.js | 6 ++++++ static/js/easysync2_client.js | 6 ++++++ static/js/linestylefilter.js | 6 ++++++ static/js/linestylefilter_client.js | 6 ++++++ static/js/pad2.js | 6 ++++++ static/js/pad_connectionstatus.js | 6 ++++++ static/js/pad_cookie.js | 6 ++++++ static/js/pad_docbar.js | 6 ++++++ static/js/pad_editbar.js | 6 ++++++ static/js/pad_editor.js | 6 ++++++ static/js/pad_impexp.js | 6 ++++++ static/js/pad_modals.js | 6 ++++++ static/js/pad_savedrevs.js | 6 ++++++ static/js/pad_userlist.js | 6 ++++++ static/js/pad_utils.js | 6 ++++++ static/js/plugins.js | 6 ++++++ static/js/skiplist.js | 6 ++++++ static/js/undo-xpopup.js | 6 ++++++ static/js/undomodule.js | 6 ++++++ static/js/virtual_lines.js | 6 ++++++ 37 files changed, 224 insertions(+), 2 deletions(-) diff --git a/node/utils/Changeset.js b/node/utils/Changeset.js index 2c9e0683..9e1b60eb 100644 --- a/node/utils/Changeset.js +++ b/node/utils/Changeset.js @@ -3,6 +3,12 @@ * Can be found in https://github.com/ether/pad/blob/master/infrastructure/ace/www/easysync2.js */ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /* * Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka (Primary Technology Ltd) * diff --git a/static/js/ace.js b/static/js/ace.js index 27899aaa..69d3cf09 100644 --- a/static/js/ace.js +++ b/static/js/ace.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/ace2_common.js b/static/js/ace2_common.js index de2fede1..1246a16e 100644 --- a/static/js/ace2_common.js +++ b/static/js/ace2_common.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * @@ -142,4 +148,4 @@ function htmlPrettyEscape(str) if (typeof exports !== "undefined") { exports.map = map; -} \ No newline at end of file +} diff --git a/static/js/ace2_inner.js b/static/js/ace2_inner.js index 663b5cca..65f8ec7e 100644 --- a/static/js/ace2_inner.js +++ b/static/js/ace2_inner.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/broadcast.js b/static/js/broadcast.js index 32424731..865574ab 100644 --- a/static/js/broadcast.js +++ b/static/js/broadcast.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/broadcast_revisions.js b/static/js/broadcast_revisions.js index 82867773..33a2f9df 100644 --- a/static/js/broadcast_revisions.js +++ b/static/js/broadcast_revisions.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/broadcast_slider.js b/static/js/broadcast_slider.js index 68f42449..af5a5041 100644 --- a/static/js/broadcast_slider.js +++ b/static/js/broadcast_slider.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/changesettracker.js b/static/js/changesettracker.js index 09e413f3..cc7f6462 100644 --- a/static/js/changesettracker.js +++ b/static/js/changesettracker.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/chat.js b/static/js/chat.js index b6f99429..4dade69f 100644 --- a/static/js/chat.js +++ b/static/js/chat.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka (Primary Technology Ltd) * @@ -168,4 +174,4 @@ var chat = (function() } return self; -}()); \ No newline at end of file +}()); diff --git a/static/js/collab_client.js b/static/js/collab_client.js index c64b9994..fafe0fd2 100644 --- a/static/js/collab_client.js +++ b/static/js/collab_client.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/colorutils.js b/static/js/colorutils.js index 03141271..92d8da71 100644 --- a/static/js/colorutils.js +++ b/static/js/colorutils.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // DO NOT EDIT THIS FILE, edit infrastructure/ace/www/colorutils.js // THIS FILE IS ALSO SERVED AS CLIENT-SIDE JS /** diff --git a/static/js/contentcollector.js b/static/js/contentcollector.js index 577b24c6..69036ba2 100644 --- a/static/js/contentcollector.js +++ b/static/js/contentcollector.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.contentcollector // %APPJET%: import("etherpad.collab.ace.easysync2.Changeset"); // %APPJET%: import("etherpad.admin.plugins"); diff --git a/static/js/cssmanager.js b/static/js/cssmanager.js index 5601ea25..b8208b83 100644 --- a/static/js/cssmanager.js +++ b/static/js/cssmanager.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/cssmanager_client.js b/static/js/cssmanager_client.js index 2fa61027..60bf9f8c 100644 --- a/static/js/cssmanager_client.js +++ b/static/js/cssmanager_client.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // DO NOT EDIT THIS FILE, edit infrastructure/ace/www/cssmanager.js /** * Copyright 2009 Google Inc. diff --git a/static/js/domline.js b/static/js/domline.js index 7732805f..56f74a1c 100644 --- a/static/js/domline.js +++ b/static/js/domline.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.domline // %APPJET%: import("etherpad.admin.plugins"); /** diff --git a/static/js/domline_client.js b/static/js/domline_client.js index d4dd4606..a152412c 100644 --- a/static/js/domline_client.js +++ b/static/js/domline_client.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // DO NOT EDIT THIS FILE, edit infrastructure/ace/www/domline.js // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.domline /** diff --git a/static/js/draggable.js b/static/js/draggable.js index 2f40c1c7..7bf523eb 100644 --- a/static/js/draggable.js +++ b/static/js/draggable.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/easysync2.js b/static/js/easysync2.js index 7f5d0cf9..17ab585d 100644 --- a/static/js/easysync2.js +++ b/static/js/easysync2.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.easysync2 // %APPJET%: jimport("com.etherpad.Easysync2Support"); /** diff --git a/static/js/easysync2_client.js b/static/js/easysync2_client.js index 5d0e582d..3611da23 100644 --- a/static/js/easysync2_client.js +++ b/static/js/easysync2_client.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // DO NOT EDIT THIS FILE, edit infrastructure/ace/www/easysync2.js // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.easysync2 /** diff --git a/static/js/linestylefilter.js b/static/js/linestylefilter.js index f6cf9f35..9164d42f 100644 --- a/static/js/linestylefilter.js +++ b/static/js/linestylefilter.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.linestylefilter // %APPJET%: import("etherpad.collab.ace.easysync2.Changeset"); // %APPJET%: import("etherpad.admin.plugins"); diff --git a/static/js/linestylefilter_client.js b/static/js/linestylefilter_client.js index b1bdae6e..69c3f124 100644 --- a/static/js/linestylefilter_client.js +++ b/static/js/linestylefilter_client.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + // DO NOT EDIT THIS FILE, edit infrastructure/ace/www/linestylefilter.js // THIS FILE IS ALSO AN APPJET MODULE: etherpad.collab.ace.linestylefilter /** diff --git a/static/js/pad2.js b/static/js/pad2.js index 1498a74c..b75c1f9c 100644 --- a/static/js/pad2.js +++ b/static/js/pad2.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka (Primary Technology Ltd) * diff --git a/static/js/pad_connectionstatus.js b/static/js/pad_connectionstatus.js index 3d244303..d35eb02d 100644 --- a/static/js/pad_connectionstatus.js +++ b/static/js/pad_connectionstatus.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_cookie.js b/static/js/pad_cookie.js index 5db6a2ca..64211750 100644 --- a/static/js/pad_cookie.js +++ b/static/js/pad_cookie.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_docbar.js b/static/js/pad_docbar.js index 6ee38f68..c67ca55c 100644 --- a/static/js/pad_docbar.js +++ b/static/js/pad_docbar.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_editbar.js b/static/js/pad_editbar.js index 97bd7f85..9de23f82 100644 --- a/static/js/pad_editbar.js +++ b/static/js/pad_editbar.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_editor.js b/static/js/pad_editor.js index dc76898c..183de948 100644 --- a/static/js/pad_editor.js +++ b/static/js/pad_editor.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_impexp.js b/static/js/pad_impexp.js index fe1d28fb..4cf7ffcd 100644 --- a/static/js/pad_impexp.js +++ b/static/js/pad_impexp.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_modals.js b/static/js/pad_modals.js index ccd4607e..cf9d0435 100644 --- a/static/js/pad_modals.js +++ b/static/js/pad_modals.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_savedrevs.js b/static/js/pad_savedrevs.js index ae4220cd..487e85f1 100644 --- a/static/js/pad_savedrevs.js +++ b/static/js/pad_savedrevs.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_userlist.js b/static/js/pad_userlist.js index e11cd3ac..74867491 100644 --- a/static/js/pad_userlist.js +++ b/static/js/pad_userlist.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/pad_utils.js b/static/js/pad_utils.js index 331590fe..76a16705 100644 --- a/static/js/pad_utils.js +++ b/static/js/pad_utils.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/plugins.js b/static/js/plugins.js index 2ebf98f3..b29d01d4 100644 --- a/static/js/plugins.js +++ b/static/js/plugins.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + plugins = { callHook: function(hookName, args) { diff --git a/static/js/skiplist.js b/static/js/skiplist.js index c2187388..c9654be4 100644 --- a/static/js/skiplist.js +++ b/static/js/skiplist.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/undo-xpopup.js b/static/js/undo-xpopup.js index 2fc0ee1a..e733f3ea 100644 --- a/static/js/undo-xpopup.js +++ b/static/js/undo-xpopup.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/undomodule.js b/static/js/undomodule.js index b070ce25..3891629a 100644 --- a/static/js/undomodule.js +++ b/static/js/undomodule.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. * diff --git a/static/js/virtual_lines.js b/static/js/virtual_lines.js index e27e4af4..ece96b14 100644 --- a/static/js/virtual_lines.js +++ b/static/js/virtual_lines.js @@ -1,3 +1,9 @@ +/** + * This code is mostly from the old Etherpad. Please help us to comment this code. + * This helps other people to understand this code better and helps them to improve it. + * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED + */ + /** * Copyright 2009 Google Inc. *