Author: desruisseaux
Date: Sat Jul 29 14:32:30 2017
New Revision: 1803376
URL: http://svn.apache.org/viewvc?rev=1803376&view=rev
Log:
Add a minimal package-info documentation.
Added:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
(with props)
Modified:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/PixelIterator.java
sis/branches/JDK8/core/sis-raster/src/test/java/org/apache/sis/image/PixelIteratorTest.java
Modified:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/PixelIterator.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/PixelIterator.java?rev=1803376&r1=1803375&r2=1803376&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/PixelIterator.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/PixelIterator.java
[UTF-8] Sat Jul 29 14:32:30 2017
@@ -38,15 +38,16 @@ import org.apache.sis.util.ArgumentCheck
import org.opengis.coverage.grid.SequenceType;
/**
- * Define standard iterator for image pixel.
+ * An iterator over sample values in an image. This iterator make easier to
get the values
+ * without managing the complexity of various {@linkplain SampleModel sample
model} and tiling.
+ * Iteration may be done on a full image or only a sub-area of it.
+ * Iteration order is implementation specific.
*
- * Iteration order is define in sub-classes implementation.
- * However iteration begging by Bands.
- *
- * Moreover comportment not specify if iterator exceed image limits.
- *
- * @author Rémi Marechal (Geomatys)
- * @author Martin Desruisseaux (Geomatys)
+ * @author Rémi Marechal (Geomatys)
+ * @author Martin Desruisseaux (Geomatys)
+ * @version 0.8
+ * @since 0.8
+ * @module
*/
public abstract class PixelIterator implements Closeable {
Added:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java?rev=1803376&view=auto
==============================================================================
---
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
(added)
+++
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
[UTF-8] Sat Jul 29 14:32:30 2017
@@ -0,0 +1,29 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Provides helper classes for handling Java2D rendered images together with
some operations.
+ * This package does not use any geospatial functions; it works only on "pure"
images (not necessarily RGB).
+ * However this package is used as a basis for georeferenced or
georeferenceable <cite>grid coverages</cite>.
+ *
+ * @author Rémi Maréchal (Geomatys)
+ * @author Martin Desruisseaux (Geomatys)
+ * @version 0.8
+ * @since 0.8
+ * @module
+ */
+package org.apache.sis.image;
Propchange:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
sis/branches/JDK8/core/sis-raster/src/main/java/org/apache/sis/image/package-info.java
------------------------------------------------------------------------------
svn:mime-type = text/plain;charset=UTF-8
Modified:
sis/branches/JDK8/core/sis-raster/src/test/java/org/apache/sis/image/PixelIteratorTest.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-raster/src/test/java/org/apache/sis/image/PixelIteratorTest.java?rev=1803376&r1=1803375&r2=1803376&view=diff
==============================================================================
---
sis/branches/JDK8/core/sis-raster/src/test/java/org/apache/sis/image/PixelIteratorTest.java
[UTF-8] (original)
+++
sis/branches/JDK8/core/sis-raster/src/test/java/org/apache/sis/image/PixelIteratorTest.java
[UTF-8] Sat Jul 29 14:32:30 2017
@@ -38,8 +38,11 @@ import static org.junit.Assert.*;
/**
* Base class of {@link PixelIterator} tests.
*
- * @author Rémi Maréchal (Geomatys)
- * @author Martin Desruisseaux (Geomatys)
+ * @author Rémi Maréchal (Geomatys)
+ * @author Martin Desruisseaux (Geomatys)
+ * @version 0.8
+ * @since 0.8
+ * @module
*/
public strictfp class PixelIteratorTest extends TestCase {
/**
