added some headers and comments;
authorwenzelm
Fri, 19 Dec 2008 22:24:32 +0100
changeset 34407 aad6834ba380
parent 34406 f81cd75ae331
child 34408 ad7b6c4813c8
added some headers and comments;
src/Tools/jEdit/src/jedit/OptionPane.scala
src/Tools/jEdit/src/jedit/Plugin.scala
src/Tools/jEdit/src/jedit/ProverSetup.scala
src/Tools/jEdit/src/jedit/TheoryView.scala
src/Tools/jEdit/src/jedit/UserAgent.scala
src/Tools/jEdit/src/jedit/VFS.scala
src/Tools/jEdit/src/proofdocument/ProofDocument.scala
src/Tools/jEdit/src/proofdocument/Text.scala
src/Tools/jEdit/src/proofdocument/Token.scala
src/Tools/jEdit/src/prover/Command.scala
src/Tools/jEdit/src/prover/CommandChangeInfo.scala
src/Tools/jEdit/src/prover/Document.scala
src/Tools/jEdit/src/prover/IsabelleSKParser.scala
src/Tools/jEdit/src/prover/MarkupNode.scala
src/Tools/jEdit/src/prover/Prover.scala
src/Tools/jEdit/src/utils/Delay.scala
src/Tools/jEdit/src/utils/EventSource.scala
--- a/src/Tools/jEdit/src/jedit/OptionPane.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/OptionPane.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Isabelle/jEdit plugin options
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.jedit
 
 import java.lang.Integer
--- a/src/Tools/jEdit/src/jedit/Plugin.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/Plugin.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * Main Isabelle/jEdit plugin setup
+ *
+ * @author Johannes Hölzl, TU Munich
+ * @author Fabian Immler, TU Munich
+ */
+
 package isabelle.jedit
 
 import java.awt.Font
--- a/src/Tools/jEdit/src/jedit/ProverSetup.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/ProverSetup.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,8 +1,7 @@
 /*
- * BufferExtension.scala
+ * 
  *
- * To change this template, choose Tools | Template Manager
- * and open the template in the editor.
+ * 
  */
 
 package isabelle.jedit
--- a/src/Tools/jEdit/src/jedit/TheoryView.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/TheoryView.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * XML/CSS rendering -- user agent
+ *
+ * @author Fabian Immler, TU Munich
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.jedit
 
 import isabelle.utils.EventSource
--- a/src/Tools/jEdit/src/jedit/UserAgent.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/UserAgent.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * XML/CSS rendering -- user agent
+ *
+ * @author Fabian Immler, TU Munich
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.jedit
 
 import java.io.ByteArrayInputStream
@@ -6,8 +13,9 @@
 import isabelle.IsabelleSystem.getenv
 
 object UserAgent {
+  // FIXME avoid static getenv
   val baseURL = "file://localhost" + getenv("ISABELLE_HOME") + "/lib/html/"
-  val userStylesheet =  "file://localhost" + getenv("ISABELLE_HOME_USER") + "/etc/user.css";
+  val userStylesheet =  "file://localhost" + getenv("ISABELLE_HOME_USER") + "/etc/user.css"
   val stylesheet = """
 
 @import "isabelle.css";
--- a/src/Tools/jEdit/src/jedit/VFS.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/jedit/VFS.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,13 @@
+/*
+ * Isabelle virtual file system for jEdit.
+ *
+ * This filesystem passes every operation on to FileVFS. Just the read and write
+ * operations are overwritten to convert Isabelle symbols to unicode on read and
+ * unicode to Isabelle symbols on write.
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.jedit
 
 import java.io.InputStream
@@ -122,15 +132,6 @@
   
 }
 
-/**
- * The Isabelle virtual file system for jEdit.
- * 
- * This filesystem passes every operation on to FileVFS. Just the read and write
- * operations are overwritten to convert the xsymbols to unicode on read and
- * unicode to xsymbols on write.
- * 
- * @author Johannes Hölzl <hoelzl@in.tum.de>
- */
 class VFS extends io.VFS("isabelle", VFSManager.getVFSForProtocol("file").getCapabilities()) {
   private var baseVFS = VFSManager.getVFSForProtocol("file") 
 
--- a/src/Tools/jEdit/src/proofdocument/ProofDocument.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/proofdocument/ProofDocument.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Document -- list of tokens
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.proofdocument
 
 import java.util.regex.Pattern
--- a/src/Tools/jEdit/src/proofdocument/Text.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/proofdocument/Text.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Text as event source
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.proofdocument
 
 import isabelle.utils.EventSource
--- a/src/Tools/jEdit/src/proofdocument/Token.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/proofdocument/Token.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * Document tokens as text ranges
+ *
+ * @author Johannes Hölzl, TU Munich
+ * @author Fabian Immler, TU Munich
+ */
+
 package isabelle.proofdocument
 
 object Token {
--- a/src/Tools/jEdit/src/prover/Command.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/Command.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * Prover commands with semantic state
+ *
+ * @author Johannes Hölzl, TU Munich
+ * @author Fabian Immler, TU Munich
+ */
+
 package isabelle.prover
 
 import isabelle.proofdocument.Token
--- a/src/Tools/jEdit/src/prover/CommandChangeInfo.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/CommandChangeInfo.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,7 @@
+/*
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.prover
 
 class CommandChangeInfo(val command : Command)
--- a/src/Tools/jEdit/src/prover/Document.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/Document.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Document -- list of commands
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.prover
 
 import isabelle.proofdocument.{ ProofDocument, Token, Text }
--- a/src/Tools/jEdit/src/prover/IsabelleSKParser.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/IsabelleSKParser.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,8 +1,7 @@
 /*
- * IsabelleSKParser.scala
+ * Sidekick parser for proof document
  *
- * To change this template, choose Tools | Template Manager
- * and open the template in the editor.
+ * @author Fabian Immler, TU Munich
  */
 
 package isabelle.prover
--- a/src/Tools/jEdit/src/prover/MarkupNode.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/MarkupNode.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,8 +1,7 @@
 /*
- * RelativeAsset.scala
+ * Document markup nodes, with connection to Swing tree model
  *
- * To change this template, choose Tools | Template Manager
- * and open the template in the editor.
+ * @author Fabian Immler, TU Munich
  */
 
 package isabelle.prover
--- a/src/Tools/jEdit/src/prover/Prover.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/prover/Prover.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,10 @@
+/*
+ * Higher-level prover communication
+ *
+ * @author Johannes Hölzl, TU Munich
+ * @author Fabian Immler, TU Munich
+ */
+
 package isabelle.prover
 
 import scala.collection.mutable.{ HashMap, HashSet }
--- a/src/Tools/jEdit/src/utils/Delay.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/utils/Delay.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Delayed actions
+ *
+ * @author Fabian Immler, TU Munich
+ */
+
 package isabelle.utils
 
 import javax.swing.Timer
--- a/src/Tools/jEdit/src/utils/EventSource.scala	Thu Dec 18 01:10:20 2008 +0100
+++ b/src/Tools/jEdit/src/utils/EventSource.scala	Fri Dec 19 22:24:32 2008 +0100
@@ -1,3 +1,9 @@
+/*
+ * Event sources with multiple handlers
+ *
+ * @author Johannes Hölzl, TU Munich
+ */
+
 package isabelle.utils
 
 import scala.collection.mutable.HashSet