@@ -42,26 +42,26 @@ include("registry.jl")
42
42
`FileIO` API (brief summary, see individual functions for more detail):
43
43
44
44
- `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`
46
46
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
48
48
- `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
52
52
53
53
- `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`
55
55
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`
61
61
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`
65
65
"""
66
66
FileIO
67
67
0 commit comments