Commit 17e6241c authored by h2b's avatar h2b

Comments cleaned up.

parent 42ff324e
......@@ -18,7 +18,7 @@
package de.h2b.scala.lib.simgraf
/**
* Provides an iterator over standard colors.
* Provides an iterator over colors.
*
* The iterator cycles over the available color sequence, so it always has a
* next color.
......@@ -44,7 +44,7 @@ class ColorIterator private (val colors: Seq[Color]) extends Iterator[Color] {
* Converts this iterator to a sequence.
*
* Although this iterator is of infinite size, this version of `toSeq`
* terminates and returns the underlying color sequence.
* terminates and returns the underlying color sequence cycle.
*/
override def toSeq: Seq[Color] = colors
......@@ -64,7 +64,10 @@ object ColorIterator {
* Returns an iterator over all standard colors defined in the `Color`
* companion object except for the ones specified.
*
* Beware, that the resulting color sequence must not be empty.
* The iterator cycles over the resulting color sequence, so it always has a
* next color.
*
* @note Beware, that the resulting color sequence must not be empty.
*
* @param exclude colors to be excluded from this iteration
* @return a new color iterator over standard colors
......@@ -78,6 +81,11 @@ object ColorIterator {
/**
* Returns an iterator over all specified colors.
*
* The iterator cycles over the available color sequence, so it always has a
* next color.
*
* @note Beware, that the specified color sequence must not be empty.
*
* @param colors
* @return a new color iterator over specified colors
* @throws IllegalArgumentException if the color sequence is empty
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment