1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00

Add documentation tags

This commit is contained in:
ed 2018-03-15 10:47:05 +00:00
parent e982c70438
commit cdbc28c18b
534 changed files with 1531 additions and 72 deletions

View file

@ -30,6 +30,8 @@ namespace juce
small read accesses to it, it's probably sensible to wrap it in one of these,
so that the source stream gets accessed in larger chunk sizes, meaning less
work for the underlying stream.
@tags{Core}
*/
class JUCE_API BufferedInputStream : public InputStream
{

View file

@ -28,6 +28,8 @@ namespace juce
A type of InputSource that represents a normal file.
@see InputSource
@tags{Core}
*/
class JUCE_API FileInputSource : public InputSource
{

View file

@ -31,6 +31,8 @@ namespace juce
caller to create an input stream that can read from it when required.
@see FileInputSource
@tags{Core}
*/
class JUCE_API InputSource
{

View file

@ -30,6 +30,8 @@ namespace juce
some or all of the virtual functions to implement their behaviour.
@see OutputStream, MemoryInputStream, BufferedInputStream, FileInputStream
@tags{Core}
*/
class JUCE_API InputStream
{

View file

@ -29,6 +29,8 @@ namespace juce
This can either be used to refer to a shared block of memory, or can make its
own internal copy of the data when the MemoryInputStream is created.
@tags{Core}
*/
class JUCE_API MemoryInputStream : public InputStream
{

View file

@ -29,6 +29,8 @@ namespace juce
The data that was written into the stream can then be accessed later as
a contiguous block of memory.
@tags{Core}
*/
class JUCE_API MemoryOutputStream : public OutputStream
{

View file

@ -31,6 +31,8 @@ namespace juce
some or all of the virtual functions to implement their behaviour.
@see InputStream, MemoryOutputStream, FileOutputStream
@tags{Core}
*/
class JUCE_API OutputStream
{

View file

@ -28,6 +28,8 @@ namespace juce
This lets you take a subsection of a stream and present it as an entire
stream in its own right.
@tags{Core}
*/
class JUCE_API SubregionStream : public InputStream
{