i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Big docs cleanup.

Browse Source 
* 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
2013-02-07 02:01:19 -05:00
parent 8cf4ba89b6
commit 820dca4df6
109 changed files with 6698 additions and 5170 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/storage/AppFileInfo.dox
+11 -7
View File
@@ -1,18 +1,21 @@
/*
* 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:
* John Scipione, [email protected]
* Ingo Weinhold, [email protected]
*
* Documentation by:
* John Scipione <[email protected]>
* Ingo Weinhold <[email protected]>
* Corresponds to:
* /trunk/headers/os/storage/AppFileInfo.h rev 42274
* /trunk/src/kits/storage/AppFileInfo.cpp rev 42274
* headers/os/storage/AppFileInfo.h rev 42274
* src/kits/storage/AppFileInfo.cpp rev 42274
*/
/*!
\file AppFileInfo.h
\ingroup storage
\ingroup libbe
\brief Provides the BAppFileInfo class.
*/
@@ -20,6 +23,7 @@
/*!
\class BAppFileInfo
\ingroup storage
\ingroup libbe
\brief Provides access to the metadata associated with executables,
libraries and add-ons.
docs/user/storage/Directory.dox
+3
View File
@@ -7,6 +7,7 @@
* Ingo Weinhold, [email protected]
* Axel Dörfler, [email protected]
* John Scipione, [email protected]
*
* Corresponds to:
* headers/os/storage/Directory.h hrev43528
* src/kits/storage/Directory.cpp hrev43528
@@ -15,6 +16,8 @@
/*!
\file Directory.h
\ingroup storage
\ingroup libbe
\brief Provides the BDirectory class.
*/
docs/user/storage/Entry.dox
+16 -8
View File
@@ -6,6 +6,7 @@
* Tyler Dauwalder
* Simon Cusack, [email protected]
* John Scipione, [email protected]
*
* Corresponds to:
* headers/os/storage/Entry.h hrev43528
* src/kits/storage/Entry.cpp hrev43528
@@ -14,12 +15,16 @@
/*!
\file Entry.h
\ingroup storage
\ingroup libbe
\brief Provides the BEntry class and entry_ref implementations.
*/
/*!
\struct entry_ref
\ingroup storage
\ingroup libbe
\brief A filesystem entry represented as a name in a concrete directory.
entry_refs may refer to pre-existing (concrete) files, as well as
@@ -120,20 +125,23 @@
/*!
\var dev_t entry_ref::device
\brief The device id of the storage device on which the entry resides
The device id of the storage device on which the entry resides.
*/
/*!
\var ino_t entry_ref::directory
\brief The inode number of the directory in which the entry resides
The inode number of the directory in which the entry resides.
*/
/*!
\var char *entry_ref::name
\brief The leaf name of the entry
The leaf name of the entry
*/
@@ -162,10 +170,10 @@ BEntry entry("/boot/home/fido");
Should be followed by a call to one of the SetTo() methods, or an
assignment.
- SetTo(const BDirectory*, const char*, bool)
- SetTo(const entry_ref*, bool)
- SetTo(const char*, bool)
- operator=(const BEntry&)
- SetTo(const BDirectory*, const char*, bool)
- SetTo(const entry_ref*, bool)
- SetTo(const char*, bool)
- operator=(const BEntry&)
*/
@@ -250,7 +258,7 @@ BEntry entry("/boot/home/fido");
\fn bool BEntry::Exists() const
\brief Returns whether or not the entry exists in the filesystem.
\returns \c true if the entry exists, \c false if the entry does not exist.
\returns \c true if the entry exists, \c false if not.
*/
docs/user/storage/EntryList.dox
+5 -3
View File
@@ -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:
@@ -7,13 +7,15 @@
* John Scipione, [email protected]
*
* Corresponds to:
* /trunk/headers/os/storage/EntryList.h rev 42794
* /trunk/src/kits/storage/EntryList.cpp rev 42794
* headers/os/storage/EntryList.h rev 42794
* src/kits/storage/EntryList.cpp rev 42794
*/
/*!
\file EntryList.h
\ingroup storage
\ingroup libbe
\brief Defines the BEntryList class.
*/
docs/user/storage/File.dox
+2
View File
@@ -15,6 +15,8 @@
/*!
\file File.h
\ingroup storage
\ingroup libbe
\brief Provides the BFile class.
*/
docs/user/storage/FilePanel.dox
+12 -2
View File
@@ -13,42 +13,52 @@
/*!
\file FilePanel.h
\ingroup storage
\ingroup libbe
\brief Provides the BFilePanel and BRefFilter classes and support enums.
*/
/*!
\enum file_panel_mode
Whether the file panel is a save or open panel.
\ingroup storage
\ingroup libbe
\brief Whether the file panel is a save or open panel.
*/
/*!
\var file_panel_mode B_OPEN_PANEL
Open panel
*/
/*!
\var file_panel_mode B_SAVE_PANEL
Save panel
*/
/*!
\enum file_panel_button
List of buttons used by the file panel
\ingroup storage
\ingroup libbe
\brief List of buttons used by the file panel
*/
/*!
\var file_panel_button B_CANCEL_BUTTON
Cancel button
*/
/*!
\var file_panel_button B_DEFAULT_BUTTON
Default button
*/
docs/user/storage/FindDirectory.dox
+5 -3
View File
@@ -1,9 +1,10 @@
/*
* 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.
*
* Documentation by:
* Adrien Destugues <[email protected]>
* Adrien Destugues, [email protected]
*
* Corresponds to:
* /trunk/headers/os/storage/FindDirectory.h rev 42600
* /trunk/src/kits/storage/FindDirectory.cpp rev 42600
@@ -13,6 +14,7 @@
/*!
\file FindDirectory.h
\ingroup storage
\ingroup libbe
\brief Provides the find_directory function.
Haiku provides a set of directories for applications to use. These can be
docs/user/storage/Mime.dox
+5 -22
View File
@@ -1,8 +1,8 @@
/*
* Copyright 2013 Haiku Inc.
* Copyright 2013 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Documentation by:
* Authors:
* Ingo Weinhold, [email protected]
* John Scipione, [email protected]
*
@@ -15,12 +15,15 @@
/*!
\file Mime.h
\ingroup storage
\ingroup libbe
\brief Provides C and Haiku-only C++ MIME-type handling functions.
*/
/*!
\enum icon_size
\ingroup storage
\ingroup libbe
\brief Legacy BeOS icon size constants.
*/
@@ -62,26 +65,6 @@
*/
/*!
\fn status_t do_mime_update(int32 what, const char *path, int recursive,
int synchronous, int force)
\brief Helper function that contacts the registrar for mime update calls.
\param what The message identifier.
\param path The path to a file or directory, or \c NULL.
\param recursive Triggers recursive behavior if not \c NULL.
\param synchronous If not \c NULL update_mime_info() waits until the
operation is finished, otherwise it returns immediately and the
update is done asynchronously.
\param force Specifies how to handle files that already have MIME
information.
\returns A status code.
\see update_mime_info
*/
/*!
\fn int update_mime_info(const char *path, int recursive, int synchronous,
int force)
docs/user/storage/MimeType.dox
+3
View File
@@ -7,6 +7,7 @@
* Ingo Weinhold, [email protected]
* Axel Dörfler, [email protected]
* John Scipione, [email protected]
*
* Corresponds to:
* headers/os/storage/MimeType.h hrev43528
* src/kits/storage/MimeType.cpp hrev43528
@@ -15,6 +16,8 @@
/*!
\file MimeType.h
\ingroup storage
\ingroup libbe
\brief Provides the BMimeType class.
*/
docs/user/storage/Node.dox
+14 -4
View File
@@ -1,25 +1,30 @@
/*
* Copyright 2002-2011, Haiku Inc.
* Copyright 2002-2011 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* Tyler Dauwalder, [email protected]
* John Scipione, [email protected]
* Ingo Weinhold, [email protected]
*
* Corresponds to:
* /trunk/headers/os/app/Node.h rev 42803
* /trunk/src/kits/app/Node.cpp rev 42803
* /trunk/headers/os/app/Node.h rev 42803
* /trunk/src/kits/app/Node.cpp rev 42803
*/
/*!
\file Node.h
\ingroup storage
\ingroup libbe
\brief Provides the BNode class and node_ref structure.
*/
/*!
\struct node_ref
\ingroup storage
\ingroup libbe
\brief Reference structure to a particular vnode on a device.
*/
@@ -71,6 +76,7 @@
/*!
\class BNode
\ingroup storage
\ingroup libbe
\brief A BNode represents a chunk of data in the filesystem.
The BNode class provides an interface for manipulating the data and
@@ -82,18 +88,22 @@
/*!
\var BNode::fFd
File descriptor for the given node.
*/
/*!
\var BNode::fAttrFd
File descriptor for the attribute directory of the node. Initialized lazily.
File descriptor for the attribute directory of the node.
Initialized lazily.
*/
/*!
\var BNode::fCStatus
The object's initialization status.
*/
docs/user/storage/BFilePanel_example.png → docs/user/storage/images/BFilePanel_example.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB