From 2afda31c8fb8cb2fbbf2801dc585f9c8c4eedc99 Mon Sep 17 00:00:00 2001 From: Niels Sascha Reedijk Date: Wed, 18 Sep 2019 06:32:53 +0100 Subject: [PATCH] API Docs: add skeletons for BBufferedDataIO, BStringList and BStackOrHeapArray --- docs/user/support/BufferedDataIO.dox | 153 ++++++++ docs/user/support/StackOrHeapArray.dox | Bin 0 -> 2738 bytes docs/user/support/StringList.dox | 470 +++++++++++++++++++++++++ 3 files changed, 623 insertions(+) create mode 100644 docs/user/support/BufferedDataIO.dox create mode 100644 docs/user/support/StackOrHeapArray.dox create mode 100644 docs/user/support/StringList.dox diff --git a/docs/user/support/BufferedDataIO.dox b/docs/user/support/BufferedDataIO.dox new file mode 100644 index 0000000000..ad8b73ad65 --- /dev/null +++ b/docs/user/support/BufferedDataIO.dox @@ -0,0 +1,153 @@ +/* + * Copyright 2019 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/support/BufferedDataIO.h hrev47422 + * src/kits/support/BufferedDataIO.cpp hrev48615 + */ + + + + +/*! + \file BufferedDataIO.h + \ingroup support + \ingroup libbe + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BBufferedDataIO + \ingroup support + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BBufferedDataIO::BBufferedDataIO(BDataIO &stream, size_t bufferSize=65536L, bool ownsStream=true, bool partialReads=false) + \brief Undocumented public method + + \param stream Undocumented + \param bufferSize Undocumented + \param ownsStream Undocumented + \param partialReads Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BBufferedDataIO::~BBufferedDataIO() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BBufferedDataIO::InitCheck() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BDataIO* BBufferedDataIO::Stream() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn size_t BBufferedDataIO::BufferSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BBufferedDataIO::OwnsStream() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BBufferedDataIO::SetOwnsStream(bool ownsStream) + \brief Undocumented public method + + \param ownsStream Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual status_t BBufferedDataIO::Flush() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual ssize_t BBufferedDataIO::Read(void *buffer, size_t size) + \brief Undocumented public method + + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual ssize_t BBufferedDataIO::Write(const void *buffer, size_t size) + \brief Undocumented public method + + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/support/StackOrHeapArray.dox b/docs/user/support/StackOrHeapArray.dox new file mode 100644 index 0000000000000000000000000000000000000000..7465b97bf3a4332dfe60860d977a850146e69027 GIT binary patch literal 2738 zcmdUx-D}fe6voeO1^`l@^ zZNv>WLXz_)=ks~ad6VClee2podtiZkus4?4+%7D$iJjWm3Z6Z;r}oUYkq#{3`I#;3 z39Cb!+0c4O`!?kW4XfN&Bg<{X(?2+e+-45Gijlxe z4@^3oinz2F_R^2-Dzm;z%1@`bedJQdzJr|V5~6LQ$X-?xYC0ue>Y0XX8Aq)F8WVhr zolma4WGyC3G)g94Z;TwA^C^gwJuoEW1RwcT_r!R)=OxaYT^Z~%ohqF!wd)?wRU~S! z!8YdOP&4AdtCdOI%HzLc`s>y-(pV6PS&@# kxRsf?kJ#TN;`$@g*DwKJ{l7GK{jM_*C-x?Hs=JE%A31@sJ^%m! literal 0 HcmV?d00001 diff --git a/docs/user/support/StringList.dox b/docs/user/support/StringList.dox new file mode 100644 index 0000000000..1916d6de1d --- /dev/null +++ b/docs/user/support/StringList.dox @@ -0,0 +1,470 @@ +/* + * Copyright 2019 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/support/StringList.h hrev47422 + * src/kits/support/StringList.cpp hrev46113 + */ + + +/*! + \file StringList.h + \ingroup support + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BStringList + \ingroup support + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BStringList::BStringList(int32 count=20) + \brief Undocumented public method + + \param count Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BStringList::BStringList(const BStringList &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BStringList::~BStringList() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Add(const BString &string, int32 index) + \brief Undocumented public method + + \param string Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Add(const BString &string) + \brief Undocumented public method + + \param string Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Add(const BStringList &list, int32 index) + \brief Undocumented public method + + \param list Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Add(const BStringList &list) + \brief Undocumented public method + + \param list Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Remove(const BString &string, bool ignoreCase=false) + \brief Undocumented public method + + \param string Undocumented + \param ignoreCase Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Remove(const BStringList &list, bool ignoreCase=false) + \brief Undocumented public method + + \param list Undocumented + \param ignoreCase Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BString BStringList::Remove(int32 index) + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Remove(int32 index, int32 count) + \brief Undocumented public method + + \param index Undocumented + \param count Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Replace(int32 index, const BString &string) + \brief Undocumented public method + + \param index Undocumented + \param string Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BStringList::MakeEmpty() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn void BStringList::Sort(bool ignoreCase=false) + \brief Undocumented public method + + \param ignoreCase Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Swap(int32 indexA, int32 indexB) + \brief Undocumented public method + + \param indexA Undocumented + \param indexB Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::Move(int32 fromIndex, int32 toIndex) + \brief Undocumented public method + + \param fromIndex Undocumented + \param toIndex Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BString BStringList::StringAt(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BString BStringList::First() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BString BStringList::Last() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::HasString(const BString &string, bool ignoreCase=false) const + \brief Undocumented public method + + \param string Undocumented + \param ignoreCase Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BStringList::IndexOf(const BString &string, bool ignoreCase=false) const + \brief Undocumented public method + + \param string Undocumented + \param ignoreCase Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BStringList::CountStrings() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::IsEmpty() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BString BStringList::Join(const char *separator, int32 length=-1) const + \brief Undocumented public method + + \param separator Undocumented + \param length Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BStringList::DoForEach(bool(*func)(const BString &string)) + \brief Undocumented public method + + \param func Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BStringList::DoForEach(bool(*func)(const BString &string, void *arg2), void *arg2) + \brief Undocumented public method + + \param func Undocumented + \param arg2 Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BStringList& BStringList::operator=(const BStringList &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::operator==(const BStringList &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BStringList::operator!=(const BStringList &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BStringList::IsFixedSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual type_code BStringList::TypeCode() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BStringList::AllowsTypeCode(type_code code) const + \brief Undocumented public method + + \param code Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual ssize_t BStringList::FlattenedSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BStringList::Flatten(void *buffer, ssize_t size) const + \brief Undocumented public method + + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BStringList::Unflatten(type_code code, const void *buffer, ssize_t size) + \brief Undocumented public method + + \param code Undocumented + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/