Big docs cleanup.
* Fixed headers including: - All rights reserved not All Rights Reserved. - name, [email protected] not name <[email protected]> - tabs and spaces - Authors: not Documented by: * Renamed string.dox to String.dox * Renamed midixxx.dox files to MidiXxx.dox * Moved images into images subdirectories and updated Doxfile. * Re-format all files with tabs instead of spaces. * Fix many spelling mistakes. * Added all files, classes, structs, and enums to libbe group.
This commit is contained in:
John Scipione
@@ -1,20 +1,22 @@
|
||||
/*
|
||||
* Copyright 2011-2012 Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2011-2012 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
* Axel Dörfler, [email protected]
|
||||
* John Scipione, [email protected]
|
||||
* Oliver Tappe, [email protected]
|
||||
*
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/Catalog.h hrev45083
|
||||
* /trunk/src/kits/locale/Catalog.cpp hrev45083
|
||||
* headers/os/locale/Catalog.h hrev45083
|
||||
* src/kits/locale/Catalog.cpp hrev45083
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file Catalog.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BCatalog class.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
@@ -8,13 +8,15 @@
|
||||
* John Scipione, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/Collator.h rev 42274
|
||||
* /trunk/src/kits/locale/Collator.cpp rev 42274
|
||||
* headers/os/locale/Collator.h rev 42274
|
||||
* src/kits/locale/Collator.cpp rev 42274
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file Collator.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BCollator class.
|
||||
*/
|
||||
|
||||
@@ -22,6 +24,7 @@
|
||||
/*!
|
||||
\class BCollator
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Class for handling locale-aware collation (sorting) of strings.
|
||||
|
||||
BCollator is designed to handle collation (sorting) of strings. Unlike
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
@@ -8,26 +8,31 @@
|
||||
* John Scipione, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/Country.h rev 42274
|
||||
* /trunk/src/kits/locale/Country.cpp rev 42274
|
||||
* headers/os/locale/Country.h rev 42274
|
||||
* src/kits/locale/Country.cpp rev 42274
|
||||
*/
|
||||
|
||||
|
||||
/*! \file Country.h
|
||||
/*!
|
||||
\file Country.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief BCountry class definition.
|
||||
*/
|
||||
|
||||
|
||||
/*! \class BCountry
|
||||
/*!
|
||||
\class BCountry
|
||||
\ingroup locale
|
||||
\brief Class representing a country
|
||||
\ingroup libbe
|
||||
\brief Class representing a country.
|
||||
|
||||
BCountry provides all the information about a particular country.
|
||||
This includes the country flag (as an HVIF icon), the localized name
|
||||
of the country, and the ISO country code.
|
||||
BCountry provides information about a particular country including the
|
||||
countries flag (as an HVIF icon), the localized name of the country,
|
||||
and the ISO country code.
|
||||
|
||||
Date, time, and numer formatting also depends to some extent on the
|
||||
language used, so they are found in the BLocale class instead.
|
||||
Date, time, and number formatting also depends to some extent on the
|
||||
language used so they are found in the BLocale class instead.
|
||||
*/
|
||||
|
||||
|
||||
@@ -85,7 +90,7 @@
|
||||
The flag is stored in HVIF format so it can be rendered at any size and
|
||||
color depth.
|
||||
|
||||
\param result The BBitmap to drag the flag into.
|
||||
\param result The BBitmap object to draw the flag into.
|
||||
|
||||
\returns \c B_OK if the drawing was successful.
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku. All rights reserved.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
@@ -7,11 +7,19 @@
|
||||
* John Scipione, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/DurationFormat.h hrev45084
|
||||
* /trunk/src/kits/locale/DurationFormat.cpp hrev45084
|
||||
* headers/os/locale/DurationFormat.h hrev45084
|
||||
* src/kits/locale/DurationFormat.cpp hrev45084
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file DurationFormat.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Contains BDurationFormat class, a time interval formatter.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BDurationFormat
|
||||
\ingroup locale
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
* Axel Dörfler, [email protected].
|
||||
* John Scipione, [email protected]
|
||||
* Oliver Tappe, [email protected].
|
||||
*
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/Locale.h rev 43095
|
||||
* /trunk/src/kits/locale/Locale.cpp rev 43095
|
||||
@@ -15,12 +15,16 @@
|
||||
|
||||
/*!
|
||||
\file Locale.h
|
||||
\brief Provides the BLocale class.
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BLocale class, the base class of the Locale Kit.
|
||||
*/
|
||||
|
||||
|
||||
/*! \class BLocale
|
||||
/*!
|
||||
\class BLocale
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Class for representing a locale and its settings.
|
||||
|
||||
A locale is defined by the combination of a country and a language.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2003-2010, Haiku. All rights reserved.
|
||||
* Copyright 2003-2010 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
@@ -8,15 +8,24 @@
|
||||
* Oliver Tappe, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/LocaleRoster.h rev 42274
|
||||
* /trunk/src/kits/locale/LocaleRoster.cpp rev 42274
|
||||
* headers/os/locale/LocaleRoster.h rev 42274
|
||||
* src/kits/locale/LocaleRoster.cpp rev 42274
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file LocaleRoster.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BLocaleRoster class to access locale data.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BLocaleRoster
|
||||
\ingroup locale
|
||||
\brief Main class for accessing the locale kit data
|
||||
\ingroup libbe
|
||||
\brief Main class for accessing the Locale Kit data.
|
||||
|
||||
The Locale Roster is the central part of the locale kit. It is a global
|
||||
object (\c be_locale_roster) storing all the useful locale data. Other
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku inc.
|
||||
* Distributed under the terms of the MIT Licence.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the MIT License.
|
||||
*
|
||||
* Authors:
|
||||
* Adrien Destugues, [email protected]
|
||||
* John Scipione, [email protected]
|
||||
* Oliver Tappe, [email protected]
|
||||
*
|
||||
* Documentation by:
|
||||
* Adrien Destugues <[email protected]>
|
||||
* John Scipione <[email protected]>
|
||||
* Oliver Tappe <[email protected]>
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/TimeZone.h rev 42274
|
||||
* /trunk/src/kits/locale/TimeZone.cpp rev 42274
|
||||
* headers/os/locale/TimeZone.h rev 42274
|
||||
* src/kits/locale/TimeZone.cpp rev 42274
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file TimeZone.h
|
||||
\brief Provides for the BTimeZone class.
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BTimeZone class.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BTimeZone
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides information about time zones.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,20 +1,29 @@
|
||||
/*
|
||||
* Copyright 2011, Haiku, Inc. All Rights Reserved.
|
||||
* Copyright 2011 Haiku, Inc. All rights reserved.
|
||||
* Distributed under the terms of the OpenBeOS License.
|
||||
*
|
||||
* Authors:
|
||||
* Axel Dörfler <[email protected]>
|
||||
* John Scipione <[email protected]>
|
||||
*
|
||||
* Axel Dörfler, [email protected]
|
||||
* John Scipione, [email protected]
|
||||
*
|
||||
* Corresponds to:
|
||||
* /trunk/headers/os/locale/UnicodeChar.h rev 42274
|
||||
* /trunk/src/kits/locale/UnicodeChar.cpp rev 42274
|
||||
* headers/os/locale/UnicodeChar.h rev 42274
|
||||
* src/kits/locale/UnicodeChar.cpp rev 42274
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\file UnicodeChar.h
|
||||
\ingroup locale
|
||||
\ingroup libbe
|
||||
\brief Provides the BUnicodeChar class.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class BUnicodeChar
|
||||
\ingroup locale
|
||||
|
||||
\ingroup libbe
|
||||
\brief Management of all information about characters.
|
||||
|
||||
This class provide a set of tools for managing the whole set of characters
|
||||
@@ -27,11 +36,12 @@
|
||||
instantiate it. You can call one of the methods passing in the character
|
||||
that you want to be examined.
|
||||
|
||||
Note all the function work with chars encoded in utf-32. This is not the
|
||||
Note all the function work with chars encoded in UTF-32. This is not the
|
||||
most usual way to handle characters, but it is the fastest. To convert an
|
||||
utf-8 string to an utf-32 character use the FromUTF8() method.
|
||||
UTF-8 string to an UTF-32 character use the FromUTF8() method.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsAlpha(uint32 c)
|
||||
\brief Determine if \a c is alphabetic.
|
||||
@@ -40,6 +50,7 @@
|
||||
alphabetic character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsAlNum(uint32 c)
|
||||
\brief Determine if \a c is alphanumeric.
|
||||
@@ -48,6 +59,7 @@
|
||||
alphabetic or numeric character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsDigit(uint32 c)
|
||||
\brief Determine if \a c is numeric.
|
||||
@@ -56,6 +68,7 @@
|
||||
number character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsHexDigit(uint32 c)
|
||||
\brief Determine if \a c is a hexadecimal digit.
|
||||
@@ -64,6 +77,7 @@
|
||||
hexadecimal number character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsUpper(uint32 c)
|
||||
\brief Determine if \a c is uppercase.
|
||||
@@ -72,6 +86,7 @@
|
||||
uppercase character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsLower(uint32 c)
|
||||
\brief Determine if \a c is lowercase.
|
||||
@@ -80,6 +95,7 @@
|
||||
lowercase character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsSpace(uint32 c)
|
||||
\brief Determine if \a c is a space.
|
||||
@@ -94,6 +110,7 @@
|
||||
\sa IsWhitespace()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsWhitespace(uint32 c)
|
||||
\brief Determine if \a c is whitespace.
|
||||
@@ -107,6 +124,7 @@
|
||||
\sa IsSpace()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsControl(uint32 c)
|
||||
\brief Determine if \a c is a control character.
|
||||
@@ -120,6 +138,7 @@
|
||||
\sa IsPrintable()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsPunctuation(uint32 c)
|
||||
\brief Determine if \a c is punctuation character.
|
||||
@@ -128,6 +147,7 @@
|
||||
punctuation character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsPrintable(uint32 c)
|
||||
\brief Determine if \a c is printable.
|
||||
@@ -140,6 +160,7 @@
|
||||
\sa IsControl()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsTitle(uint32 c)
|
||||
\brief Determine if \a c is title case.
|
||||
@@ -150,6 +171,7 @@
|
||||
character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsDefined(uint32 c)
|
||||
\brief Determine if \a c is defined.
|
||||
@@ -160,6 +182,7 @@
|
||||
\returns \c true if the specified unicode character is defined.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static bool BUnicodeChar::IsBase(uint32 c)
|
||||
\brief Determine if \a c can be used with a diacritic.
|
||||
@@ -170,6 +193,7 @@
|
||||
form character that can be used with a diacritic.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn static int8 BUnicodeChar::Type(uint32 c)
|
||||
\brief Gets the type of a character.
|
||||
@@ -177,6 +201,7 @@
|
||||
\returns A member of the \c unicode_char_category enum.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn uint32 BUnicodeChar::ToLower(uint32 c)
|
||||
\brief Transforms \a c to lowercase.
|
||||
@@ -184,6 +209,7 @@
|
||||
\returns The lowercase version of the specified unicode character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn uint32 BUnicodeChar::ToUpper(uint32 c)
|
||||
\brief Transforms \a c to uppercase.
|
||||
@@ -191,6 +217,7 @@
|
||||
\returns The uppercase version of the specified unicode character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn uint32 BUnicodeChar::ToTitle(uint32 c)
|
||||
\brief Transforms \a c to title case.
|
||||
@@ -198,6 +225,7 @@
|
||||
\returns The title case version of the specified unicode character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn int32 BUnicodeChar::DigitValue(uint32 c)
|
||||
\brief Gets the numeric value \a c.
|
||||
@@ -205,33 +233,37 @@
|
||||
\returns The numeric version of the specified unicode character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BUnicodeChar::ToUTF8(uint32 c, char **out)
|
||||
\brief Transform a character to utf-8 encoding.
|
||||
\brief Transform a character to UTF-8 encoding.
|
||||
|
||||
\returns The utf-8 encoding of the specified unicode character.
|
||||
\returns The UTF-8 encoding of the specified unicode character.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn uint32 BUnicodeChar::FromUTF8(const char **in)
|
||||
\brief Transform a utf-8 string to an utf-32 character.
|
||||
\brief Transform a UTF-8 string to an UTF-32 character.
|
||||
|
||||
If the string contains multiple characters, only the fist one is used.
|
||||
This function updates the in pointer so that it points on the next
|
||||
character for the following call.
|
||||
|
||||
\returns The utf-32 encoded version of \a in.
|
||||
\returns The UTF-32 encoded version of \a in.
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn size_t BUnicodeChar::UTF8StringLength(const char *str)
|
||||
\brief Counts the characters in the given \c NUL terminated string.
|
||||
|
||||
\returns the number of utf-8 characters in the \c NUL terminated string.
|
||||
\returns the number of UTF-8 characters in the \c NUL terminated string.
|
||||
|
||||
\sa BString::CountChars()
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn size_t BUnicodeChar::UTF8StringLength(const char *str, size_t maxLength)
|
||||
\brief Counts the characters in the given string up to \a maxLength
|
||||
@@ -240,6 +272,6 @@
|
||||
The string does not need to be \c NUL terminated if you specify a
|
||||
\a maxLength that is shorter than the maximum length of the string.
|
||||
|
||||
\returns the number of utf-8 characters in the \c NUL terminated string
|
||||
\returns the number of UTF-8 characters in the \c NUL terminated string
|
||||
up to \a maxLength characters.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user