From dbe0e2bc384fdf7eac0312859347aa62a4778390 Mon Sep 17 00:00:00 2001 From: michelou Date: Tue, 7 Jul 2009 10:18:05 +0000 Subject: fixed Scala comments, added svn:keywords --- src/actors/scala/actors/ReplyReactor.scala | 14 +-- .../scala/tools/nsc/doc/ModelExtractor.scala | 8 +- src/library/scala/annotation/switch.scala | 20 +++- .../scala/collection/BufferedIterator.scala | 4 +- src/library/scala/collection/DefaultMap.scala | 25 +++-- src/library/scala/collection/Iterable.scala | 35 ++++--- src/library/scala/collection/IterableProxy.scala | 6 +- src/library/scala/collection/JavaConversions.scala | 69 +++++++------ src/library/scala/collection/LinearSequence.scala | 13 ++- src/library/scala/collection/Map.scala | 41 ++++---- src/library/scala/collection/MapProxy.scala | 4 +- src/library/scala/collection/Set.scala | 1 - src/library/scala/collection/SetProxy.scala | 4 +- src/library/scala/collection/SortedMap.scala | 2 +- src/library/scala/collection/Traversable.scala | 17 ++-- src/library/scala/collection/Vector.scala | 2 +- .../collection/generic/ImmutableMapTemplate.scala | 38 ++++--- .../collection/generic/IterableForwarder.scala | 22 ++-- .../collection/generic/IterableTemplate.scala | 35 ++++--- .../scala/collection/generic/IterableView.scala | 1 + .../collection/generic/IterableViewTemplate.scala | 1 + .../scala/collection/generic/MapTemplate.scala | 38 ++++--- .../scala/collection/generic/SetTemplate.scala | 38 ++++--- .../collection/generic/TraversableForwarder.scala | 24 +++-- .../collection/generic/TraversableTemplate.scala | 112 ++++++++++++--------- .../scala/collection/generic/TraversableView.scala | 7 +- .../collection/generic/TraversableView.scala.1 | 8 +- .../generic/TraversableViewTemplate.scala | 7 +- src/library/scala/collection/immutable/Set.scala | 21 ++-- .../scala/collection/mutable/Iterable.scala | 16 ++- src/library/scala/collection/script/Location.scala | 6 +- src/library/scala/reflect/OptManifest.scala | 10 +- src/library/scala/util/Marshal.scala | 13 ++- src/swing/scala/swing/AbstractButton.scala | 11 ++ src/swing/scala/swing/Action.scala | 11 ++ src/swing/scala/swing/Alignment.scala | 11 ++ src/swing/scala/swing/Applet.scala | 28 ++++-- src/swing/scala/swing/BorderPanel.scala | 11 ++ src/swing/scala/swing/BoxPanel.scala | 11 ++ src/swing/scala/swing/BufferWrapper.scala | 11 ++ src/swing/scala/swing/Button.scala | 11 ++ src/swing/scala/swing/ButtonGroup.scala | 11 ++ src/swing/scala/swing/CheckBox.scala | 11 ++ src/swing/scala/swing/ComboBox.scala | 13 ++- src/swing/scala/swing/Component.scala | 11 ++ src/swing/scala/swing/Container.scala | 11 ++ src/swing/scala/swing/FileChooser.scala | 11 ++ src/swing/scala/swing/FlowPanel.scala | 11 ++ src/swing/scala/swing/FormattedTextField.scala | 13 ++- src/swing/scala/swing/GUIApplication.scala | 11 ++ src/swing/scala/swing/GridBagPanel.scala | 11 ++ src/swing/scala/swing/GridPanel.scala | 11 ++ src/swing/scala/swing/Label.scala | 11 ++ src/swing/scala/swing/LayoutContainer.scala | 26 +++-- src/swing/scala/swing/ListView.scala | 11 ++ src/swing/scala/swing/MainFrame.scala | 11 ++ src/swing/scala/swing/Menu.scala | 11 ++ src/swing/scala/swing/Orientable.scala | 11 ++ src/swing/scala/swing/Orientation.scala | 11 ++ src/swing/scala/swing/Oriented.scala | 11 ++ src/swing/scala/swing/Panel.scala | 11 ++ src/swing/scala/swing/PasswordField.scala | 11 ++ src/swing/scala/swing/ProgressBar.scala | 13 ++- src/swing/scala/swing/Publisher.scala | 35 +++++-- src/swing/scala/swing/RadioButton.scala | 13 ++- src/swing/scala/swing/Reactions.scala | 11 ++ src/swing/scala/swing/Reactor.scala | 11 ++ src/swing/scala/swing/RichWindows.scala | 11 ++ src/swing/scala/swing/RootPanel.scala | 11 ++ src/swing/scala/swing/ScrollPane.scala | 13 ++- src/swing/scala/swing/Scrollable.scala | 11 ++ src/swing/scala/swing/Separator.scala | 11 ++ src/swing/scala/swing/SequentialContainer.scala | 11 ++ src/swing/scala/swing/SimpleGUIApplication.scala | 11 ++ src/swing/scala/swing/Slider.scala | 11 ++ src/swing/scala/swing/SplitPane.scala | 13 ++- src/swing/scala/swing/Swing.scala | 11 ++ src/swing/scala/swing/SwingActor.scala | 11 ++ src/swing/scala/swing/TabbedPane.scala | 11 ++ src/swing/scala/swing/Table.scala | 11 ++ src/swing/scala/swing/TextArea.scala | 13 ++- src/swing/scala/swing/TextComponent.scala | 13 ++- src/swing/scala/swing/TextField.scala | 11 ++ src/swing/scala/swing/ToggleButton.scala | 11 ++ src/swing/scala/swing/UIElement.scala | 13 ++- src/swing/scala/swing/Window.scala | 13 ++- src/swing/scala/swing/event/ActionEvent.scala | 11 ++ src/swing/scala/swing/event/AdjustingEvent.scala | 24 ++++- .../scala/swing/event/BackgroundChanged.scala | 11 ++ src/swing/scala/swing/event/ButtonClicked.scala | 11 ++ src/swing/scala/swing/event/CaretUpdate.scala | 11 ++ src/swing/scala/swing/event/ComponentEvent.scala | 11 ++ src/swing/scala/swing/event/ContainerEvent.scala | 11 ++ src/swing/scala/swing/event/EditDone.scala | 11 ++ src/swing/scala/swing/event/Event.scala | 11 ++ src/swing/scala/swing/event/FocusEvent.scala | 13 ++- src/swing/scala/swing/event/FontChanged.scala | 11 ++ .../scala/swing/event/ForegroundChanged.scala | 11 ++ src/swing/scala/swing/event/InputEvent.scala | 11 ++ src/swing/scala/swing/event/Key.scala | 11 ++ src/swing/scala/swing/event/KeyEvent.scala | 11 ++ src/swing/scala/swing/event/ListEvent.scala | 13 ++- src/swing/scala/swing/event/MouseEvent.scala | 13 ++- src/swing/scala/swing/event/SelectionEvent.scala | 13 ++- src/swing/scala/swing/event/TableEvent.scala | 13 ++- src/swing/scala/swing/event/UIEvent.scala | 13 ++- src/swing/scala/swing/event/ValueChanged.scala | 11 ++ src/swing/scala/swing/event/WindowActivated.scala | 11 ++ src/swing/scala/swing/event/WindowClosing.scala | 11 ++ .../scala/swing/event/WindowDeactivated.scala | 11 ++ .../scala/swing/event/WindowDeiconified.scala | 11 ++ src/swing/scala/swing/event/WindowEvent.scala | 11 ++ src/swing/scala/swing/event/WindowIconified.scala | 11 ++ src/swing/scala/swing/event/WindowOpened.scala | 11 ++ src/swing/scala/swing/model/Matrix.scala | 11 ++ 115 files changed, 1365 insertions(+), 300 deletions(-) (limited to 'src') diff --git a/src/actors/scala/actors/ReplyReactor.scala b/src/actors/scala/actors/ReplyReactor.scala index 7e8bc0ab37..1fb564f626 100644 --- a/src/actors/scala/actors/ReplyReactor.scala +++ b/src/actors/scala/actors/ReplyReactor.scala @@ -10,14 +10,14 @@ package scala.actors -/** - * The ReplyReactor trait extends the Reactor trait with - * methods to reply to the sender of a message. - * Sending a message to a ReplyReactor implicitly - * passes a reference to the sender together with the - * message. +/**

+ * The ReplyReactor trait extends the Reactor + * trait with methods to reply to the sender of a message. + * Sending a message to a ReplyReactor implicitly + * passes a reference to the sender together with the message. + *

* - * @author Philipp Haller + * @author Philipp Haller */ trait ReplyReactor extends Reactor { diff --git a/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala b/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala index 328f2713af..3e827aa0b1 100644 --- a/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala +++ b/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala @@ -50,7 +50,11 @@ trait ModelExtractor { } protected def decodeComment(comment0: String): Comment = { - val comment = comment0 // .substring("/**".length, comment0.length - "*/".length) + val comment = { // discard outmost comment delimiters if present + val begin = if (comment0 startsWith "/**") 3 else 0 + val end = comment0.length - (if (comment0 endsWith "*/") 2 else 0) + comment0.substring(begin, end) + } val tok = new java.util.StringTokenizer(comment, LINE_SEPARATOR) val buf = new StringBuilder type AttrDescr = (String, String, StringBuilder) @@ -415,7 +419,7 @@ trait ModelExtractor { import java.util.regex.Pattern // patterns for standard tags with 1 and 2 arguments private val pat1 = Pattern.compile( - "[ \t]*@(author|deprecated|pre|return|see|since|todo|version|ex|note)[ \t]*(.*)") + "[ \t]*@(author|deprecated|owner|pre|return|see|since|todo|version|ex|note)[ \t]*(.*)") private val pat2 = Pattern.compile( "[ \t]*@(exception|param|throws)[ \t]+(\\p{Graph}*)[ \t]*(.*)") diff --git a/src/library/scala/annotation/switch.scala b/src/library/scala/annotation/switch.scala index 5ecbf73905..1dfd0af88d 100644 --- a/src/library/scala/annotation/switch.scala +++ b/src/library/scala/annotation/switch.scala @@ -11,7 +11,23 @@ package scala.annotation * An annotation to be applied to a match expression. If present, * the compiler will verify that the match has been compiled to a * tableswitch or lookupswitch, and issue an error if it instead - * compiles into a series of conditional expressions. + * compiles into a series of conditional expressions.
+ * Example: *

+ * 
+ *    def fetchToken() {
+ *      (ch: @switch) match {
+ *        case ' ' | '\t' | CR | LF | FF =>
+ *          nextChar()
+ *          fetchToken()
+ *        case 'A' /*..'Z'*/ | '$' | '_' | 'a' /*..'z'*/ =>
+ *          putChar(ch)
+ *          nextChar()
+ *          getIdentRest()
+ *        case ',' =>
+ *          nextChar(); token = COMMA
+ *        // more cases
+ *      }
+ *    }
*/ -final class switch extends StaticAnnotation \ No newline at end of file +final class switch extends StaticAnnotation diff --git a/src/library/scala/collection/BufferedIterator.scala b/src/library/scala/collection/BufferedIterator.scala index 44dc6925ea..c59d4f50b1 100644 --- a/src/library/scala/collection/BufferedIterator.scala +++ b/src/library/scala/collection/BufferedIterator.scala @@ -11,8 +11,8 @@ package scala.collection -/** Buffered iterators are iterators which provide a method `head` that inspects the next - * element without discarding it. +/** Buffered iterators are iterators which provide a method head + * that inspects the next element without discarding it. * * @author Martin Odersky * @version 2.8 diff --git a/src/library/scala/collection/DefaultMap.scala b/src/library/scala/collection/DefaultMap.scala index bb3a0defa0..8c605f536d 100644 --- a/src/library/scala/collection/DefaultMap.scala +++ b/src/library/scala/collection/DefaultMap.scala @@ -13,16 +13,21 @@ package scala.collection import generic._ -/* A default map which implements the `updated` and `-` methods of maps. - * Instances that inherit from DefaultMap[A, B] still have to define: - * - * def get(key: A): Option[B] - * def iterator: Iterator[(A, B)] - * - * It refers back to the original map. - * - * It might also be advisable to override `foreach` or `size` if efficient - * implementations can be found. +/**

+ * A default map which implements the updated and - + * methods of maps.
+ * Instances that inherit from DefaultMap[A, B] still have to + * define: + * 

+ *    def get(key: A): Option[B]
+ *    def iterator: Iterator[(A, B)]
+ *

+ * It refers back to the original map. + *

+ *

+ * It might also be advisable to override foreach or + * size if efficient implementations can be found. + *

*/ trait DefaultMap[A, +B] extends Map[A, B] { self => diff --git a/src/library/scala/collection/Iterable.scala b/src/library/scala/collection/Iterable.scala index 9975e45bec..c3a3082e8a 100644 --- a/src/library/scala/collection/Iterable.scala +++ b/src/library/scala/collection/Iterable.scala @@ -14,19 +14,28 @@ import util.control.Breaks._ // import immutable.Stream import generic._ -/** A template trait for iterable collections. - * - * Collection classes mixing in this trait provide a method - * iterator which returns an iterator over all the - * elements contained in the collection. They also provide a method `newBuilder` - * which creates a builder for collections of the same kind. - * - * This trait implements Traversable's `foreach` method by stepping through - * all elements. Subclasses of `Iterable` should re-implement `foreach` with - * something more efficient, if possible. - * - * This trait adds methods `iterator`, `zip`, `zipAll`, `zipWithIndex`, `sameElements`, - * `takeRight`, `dropRight` to the methods inherited from trait `Traversable`. +/**

+ * A template trait for iterable collections. + *

+ *

+ * Collection classes mixing in this trait provide a method + * iterator which returns an iterator over all the + * elements contained in the collection. They also provide a method + * newBuilder which creates a builder for collections + * of the same kind. + *

+ *

+ * This trait implements Traversable's foreach + * method by stepping through all elements. Subclasses of Iterable + * should re-implement foreach with something more efficient, + * if possible. + *

+ *

+ * This trait adds methods iterator, zip, + * zipAll, zipWithIndex, sameElements, + * takeRight, dropRight to the methods inherited + * from trait Traversable. + *

* * @author Martin Odersky * @version 2.8 diff --git a/src/library/scala/collection/IterableProxy.scala b/src/library/scala/collection/IterableProxy.scala index 6bb12e84dc..125b470ad7 100644 --- a/src/library/scala/collection/IterableProxy.scala +++ b/src/library/scala/collection/IterableProxy.scala @@ -16,8 +16,10 @@ import generic._ // Methods could be printed by cat Traversibe.scala | egrep '^ (override )?def' -/** This trait implements a proxy for iterable objects. It forwards - * all calls to a different iterable object +/**

+ * This trait implements a proxy for iterable objects. It forwards + * all calls to a different iterable object. + *

* * @author Martin Odersky * @version 2.8 diff --git a/src/library/scala/collection/JavaConversions.scala b/src/library/scala/collection/JavaConversions.scala index b118529f00..d1b4d7ffb7 100644 --- a/src/library/scala/collection/JavaConversions.scala +++ b/src/library/scala/collection/JavaConversions.scala @@ -10,41 +10,44 @@ package scala.collection -/** - * A collection of implicit conversions supporting interoperability between Scala and Java - * collections. - *

- * The following conversions are supported, - *

- *