Skip to content

Commit

Permalink
Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@couet
couet committed Sep 9, 2015
1 parent 4dd79ef commit 72446c5
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 70 deletions.
12 changes: 0 additions & 12 deletions core/base/inc/TAttBBox2D.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,6 @@
#ifndef ROOT_TAttBBox2D
#define ROOT_TAttBBox2D

//////////////////////////////////////////////////////////////////////////
// //
// TAttBBox2D //
// //
// Abstract base class for elements drawn in the editor. //
// Classes inhereting from TAttBBox2D implementing the TAttBBox2D //
// virtual classes, and using TPad::ShowGuideLines in ExecuteEvent //
// will autimatically get the guide lines drawn when moved in the pad. //
// All methods work with pixel coordinates. //
// //
//////////////////////////////////////////////////////////////////////////

#ifndef ROOT_GuiTypes
#include "GuiTypes.h"
#endif
Expand Down
5 changes: 5 additions & 0 deletions core/base/src/TAttBBox2D.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
ClassImp(TAttBBox2D)

/** \class TAttBBox2D
Abstract base class for elements drawn in the editor.
Classes inheriting from TAttBBox2D implementing the TAttBBox2D
virtual classes, and using TPad::ShowGuideLines in ExecuteEvent
will automatically get the guide lines drawn when moved in the pad.
All methods work with pixel coordinates.
*/

////////////////////////////////////////////////////////////////////////////////
Expand Down
12 changes: 4 additions & 8 deletions core/base/src/TBenchmark.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,9 @@ TBenchmark *gBenchmark = 0;

ClassImp(TBenchmark)

//////////////////////////////////////////////////////////////////////////
// //
// TBenchmark //
// //
// This class is a ROOT utility to help benchmarking applications //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBenchmark
This class is a ROOT utility to help benchmarking applications
*/

////////////////////////////////////////////////////////////////////////////////
/// Benchmark default constructor
Expand Down Expand Up @@ -196,7 +192,7 @@ void TBenchmark::Start(const char *name)
fTimer[bench].Continue();
}
else
Warning("Start","too many benchemarks");
Warning("Start","too many benchmarks");
}

////////////////////////////////////////////////////////////////////////////////
Expand Down
67 changes: 26 additions & 41 deletions core/base/src/TBrowser.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,16 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/

//////////////////////////////////////////////////////////////////////////
// //
// Using a TBrowser one can browse all ROOT objects. It shows in a list //
// on the left side of the window all browsable ROOT classes. Selecting //
// one of the classes displays, in the iconbox on the right side, all //
// objects in the class. Selecting one of the objects in the iconbox, //
// will place all browsable objects in a new list and draws the //
// contents of the selected class in the iconbox. And so on.... //
// //
//Begin_Html <img src="gif/browser.gif"> End_Html //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBrowser
Using a TBrowser one can browse all ROOT objects. It shows in a list
on the left side of the window all browsable ROOT classes. Selecting
one of the classes displays, in the icon-box on the right side, all
objects in the class. Selecting one of the objects in the icon-box,
will place all browsable objects in a new list and draws the
contents of the selected class in the icon-box. And so on....
\image html base_browser.png
*/

#include "TBrowser.h"
#include "TGuiFactory.h"
Expand All @@ -34,11 +32,8 @@
#include "TClass.h"
#include "TApplication.h"

//////////////////////////////////////////////////////////////////////////
// //
// TBrowserTimer //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBrowserTimer
*/

class TBrowserTimer : public TTimer {

Expand All @@ -52,16 +47,13 @@ class TBrowserTimer : public TTimer {
Bool_t Notify();
};

//////////////////////////////////////////////////////////////////////////
// //
// TBrowserObject //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBrowserObject
This class is designed to wrap a Foreign object in order to
inject it into the Browse sub-system.
*/

class TBrowserObject : public TNamed
{
// This class is designed to wrap a Foreign object in order to
// inject it into the Browse sub-system.

public:

Expand Down Expand Up @@ -276,7 +268,9 @@ void TBrowser::Add(TObject *obj, const char *name, Int_t check)
/// Add foreign object with name to browser.
/// 'cl' is the type use to store the value of obj.
/// So literally the following pseudo code should be correct:
///~~~ {.cpp}
/// `cl->GetName()` * ptr = (`cl->GetName()`*) obj;
///~~~
/// and the value of obj is not necessarily the start of the object.
/// If check < 0 (default) no check box is drawn, if 0 then
/// unchecked checkbox is added, if 1 checked checkbox is added.
Expand Down Expand Up @@ -356,7 +350,7 @@ void TBrowser::Create(TObject *obj)

////////////////////////////////////////////////////////////////////////////////
/// Execute default action for selected object (action is specified
/// in the $HOME/.root.mimes or $ROOTSYS/etc/root.mimes file).
/// in the `$HOME/.root.mimes` or `$ROOTSYS/etc/root.mimes file`).

void TBrowser::ExecuteDefaultAction(TObject *obj)
{
Expand Down Expand Up @@ -393,14 +387,9 @@ void TBrowser::SetSelected(TObject *clickedObject)
fLastSelectedObject = clickedObject;
}

//////////////////////////////////////////////////////////////////////////
// //
// TBrowserTimer //
// //
//////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// Called whenever timer times out.
/** \class TBrowserTimer
Called whenever timer times out.
*/

Bool_t TBrowserTimer::Notify()
{
Expand All @@ -418,14 +407,10 @@ Bool_t TBrowserTimer::Notify()
return kFALSE;
}

//////////////////////////////////////////////////////////////////////////
// //
// TBrowserObject //
// //
// This is a wrapper class to emulate the TObject interface //
// around an object of a non-TObject class //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBrowserObject
This is a wrapper class to emulate the TObject interface
around an object of a non-TObject class
*/

////////////////////////////////////////////////////////////////////////////////
/// Constructor.
Expand Down
11 changes: 3 additions & 8 deletions core/base/src/TBrowserImp.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/

//________________________________________________________________________
//////////////////////////////////////////////////////////////////////////
// //
// TBrowserImp //
// //
// ABC describing GUI independent browser implementation protocol. //
// //
//////////////////////////////////////////////////////////////////////////
/** \class TBrowserImp
ABC describing GUI independent browser implementation protocol.
*/

#include "TBrowserImp.h"

Expand Down
3 changes: 2 additions & 1 deletion core/base/src/TBuffer.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ TBuffer::~TBuffer()
fParent = 0;
}


////////////////////////////////////////////////////////////////////////////////
/// Automatically calculate a new size and expand the buffer to fit at least size_needed.
/// The goals is to minimize the number of memory allocation and the memory allocation
/// which avoiding too much memory wastage.
///
/// If the size_needed is larger than the current size, the policy
/// is to expand to double the current size or the size_needed which ever is largest.

Expand All @@ -155,6 +155,7 @@ void TBuffer::AutoExpand(Int_t size_needed)
/// If the TBuffer owned the previous buffer, it will be deleted prior
/// to accepting the new buffer. By default the new buffer will be
/// adopted unless adopt is false.
///
/// If the new buffer is _not_ adopted and no memory allocation routine
/// is provided, a Fatal error will be issued if the Buffer attempts to
/// expand.
Expand Down
Binary file added documentation/doxygen/images/base_browser.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 72446c5

Please sign in to comment.