Skip to content

Commit c8f3ba1

Browse files
committed
Add markdown ref links to types and methods
1 parent c201e5c commit c8f3ba1

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

src/FileIO.jl

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,26 @@ include("registry.jl")
4242
`FileIO` API (brief summary, see individual functions for more detail):
4343
4444
- `format"PNG"`: specifies a particular defined format
45-
- `File{fmt}` and `Stream{fmt}`: types of objects that declare that a resource has a particular format `fmt`
45+
- [`File{fmt}`](@ref) and [`Stream{fmt}`](@ref): types of objects that declare that a resource has a particular format `fmt`
4646
47-
- `load([filename|stream])`: read data in formatted file, inferring the format
47+
- [`load([filename|stream])`](@ref): read data in formatted file, inferring the format
4848
- `load(File{format"PNG"}(filename))`: specify the format manually
49-
- `loadstreaming([filename|stream])`: similar to `load`, except that it returns an object that can be read from
50-
- `save(filename, data...)` for similar operations involving saving data
51-
- `savestreaming([filename|stream])`: similar to `save`, except that it returns an object that can be written to
49+
- [`loadstreaming([filename|stream])`](@ref): similar to `load`, except that it returns an object that can be read from
50+
- [`save(filename, data...)`](@ref) for similar operations involving saving data
51+
- [`savestreaming([filename|stream])`](@ref): similar to `save`, except that it returns an object that can be written to
5252
5353
- `io = open(f::File, args...)` opens a file
54-
- `io = stream(s::Stream)` returns the IOStream from the query object `s`
54+
- [`io = stream(s::Stream)`](@ref stream) returns the IOStream from the query object `s`
5555
56-
- `query([filename|stream])`: attempt to infer the format of `filename`
57-
- `unknown(q)` returns true if a query can't be resolved
58-
- `skipmagic(io, fmt)` sets the position of `io` to just after the magic bytes
59-
- `magic(fmt)` returns the magic bytes for format `fmt`
60-
- `info(fmt)` returns `(magic, extensions)` for format `fmt`
56+
- [`query([filename|stream])`](@ref): attempt to infer the format of `filename`
57+
- [`unknown(q)`](@ref) returns true if a query can't be resolved
58+
- [`skipmagic(io, fmt)`](@ref) sets the position of `io` to just after the magic bytes
59+
- [`magic(fmt)`](@ref) returns the magic bytes for format `fmt`
60+
- [`info(fmt)`](@ref) returns `(magic, extensions)` for format `fmt`
6161
62-
- `add_format(fmt, magic, extension, libraries...)`: register a new format
63-
- `add_loader(fmt, :Package)`: indicate that `Package` supports loading files of type `fmt`
64-
- `add_saver(fmt, :Package)`: indicate that `Package` supports saving files of type `fmt`
62+
- [`add_format(fmt, magic, extension, libraries...)`](@ref): register a new format
63+
- [`add_loader(fmt, :Package)`](@ref): indicate that `Package` supports loading files of type `fmt`
64+
- [`add_saver(fmt, :Package)`](@ref): indicate that `Package` supports saving files of type `fmt`
6565
"""
6666
FileIO
6767

0 commit comments

Comments
 (0)