Skip to content

Commit d047371

Browse files
committed
Standardize @see and @test API doc references
1 parent b3370ae commit d047371

82 files changed

Lines changed: 201 additions & 207 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/main/php/io/Channel.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
* A channel is a means for bidirectional communication and provides
55
* both an input stream for reading and an output stream for writing.
66
*
7-
* @see xp://io.File
8-
* @see xp://peer.Socket
7+
* @see io.File
8+
* @see peer.Socket
99
*/
1010
interface Channel {
1111

src/main/php/io/EncapsedStream.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/**
66
* Encapsulated / embedded stream
77
*
8-
* @test xp://net.xp_framework.unittest.io.EncapsedStreamTest
8+
* @test io.unittest.EncapsedStreamTest
99
*/
1010
class EncapsedStream extends File {
1111
private $_super, $_offset, $_size;

src/main/php/io/File.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* Instances of the file class serve as an opaque handle to the underlying machine-
88
* specific structure representing an open file.
99
*
10-
* @test xp://net.xp_framework.unittest.io.FileTest
11-
* @test xp://net.xp_framework.unittest.io.FileIntegrationTest
10+
* @test io.unittest.FileTest
11+
* @test io.unittest.FileIntegrationTest
1212
*/
1313
class File implements Channel, Value {
1414
const READ = 'rb'; // Read

src/main/php/io/Folder.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* $d->close();
1515
* ```
1616
*
17-
* @test xp://net.xp_framework.unittest.io.FolderTest
17+
* @test io.unittest.FolderTest
1818
*/
1919
class Folder implements Value {
2020
public

src/main/php/io/FolderEntries.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
/**
77
* Folder entries provides an iterable view of the files inside a given folder
88
*
9-
* @test xp://net.xp_framework.unittest.io.FolderEntriesTest
10-
* @see xp://io.Folder#entries
9+
* @see io.Folder#entries
10+
* @test io.unittest.FolderEntriesTest
1111
*/
1212
class FolderEntries implements IteratorAggregate {
1313
private $base;

src/main/php/io/Path.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Represents a file system path
1010
*
1111
* @see https://blogs.msdn.microsoft.com/jeremykuhne/2016/04/21/path-normalization/
12-
* @test xp://net.xp_framework.unittest.io.PathTest
12+
* @test io.unittest.PathTest
1313
*/
1414
class Path implements Value {
1515
const EXISTING = true;

src/main/php/io/TempFile.class.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
* same name. This would have to happen within the same
2828
* microsecond, though, and is therefore quite unlikely.
2929
*
30-
* @see xp://io.File
31-
* @see xp://lang.Environment#tempDir
32-
* @test xp://net.xp_framework.unittest.io.TempFileTest
30+
* @see io.File
31+
* @see lang.Environment#tempDir
32+
* @test io.unittest.TempFileTest
3333
*/
3434
class TempFile extends File {
3535
private $persistent= false;

src/main/php/io/streams/FileInputStream.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* InputStream that reads from a file
99
*
10-
* @test xp://net.xp_framework.unittest.io.streams.FileInputStreamTest
10+
* @test io.unittest.FileInputStreamTest
1111
*/
1212
class FileInputStream implements InputStream, Seekable, Value {
1313
use Comparison;

src/main/php/io/streams/FileOutputStream.class.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* OuputStream that writes to files
99
*
10-
* @test xp://net.xp_framework.unittest.io.streams.FileOutputStreamTest
10+
* @test io.unittest.FileOutputStreamTest
1111
*/
1212
class FileOutputStream implements OutputStream, Seekable, Truncation, Value {
1313
use Comparison;

src/main/php/io/streams/LinesIn.class.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* Represents the lines inside an input stream of bytes, delimited
88
* by either Unix, Mac or Windows line endings.
99
*
10-
* @see xp://io.streams.Reader#lines
11-
* @test xp://net.xp_framework.unittest.io.streams.LinesInTest
10+
* @see io.streams.Reader#lines
11+
* @test io.unittest.LinesInTest
1212
*/
1313
class LinesIn implements IteratorAggregate {
1414
private $reader, $reset;

0 commit comments

Comments
 (0)