From cae0cf08f4d4ee3fd204a2e5d1d3f1bdc1bce6b6 Mon Sep 17 00:00:00 2001
From: Olivier Couet <olivier.couet@cern.ch>
Date: Thu, 20 Aug 2015 16:25:23 +0200
Subject: [PATCH] Doxygen formatting
---
tree/tree/src/TTreeCloner.cxx | 18 +++++++-----------
tree/tree/src/TTreeResult.cxx | 18 +++++++-----------
tree/tree/src/TTreeRow.cxx | 16 ++++++----------
tree/tree/src/TTreeSQL.cxx | 10 +++-------
tree/tree/src/TVirtualIndex.cxx | 8 +++-----
tree/tree/src/TVirtualTreePlayer.cxx | 14 +++++---------
tree/tree/src/TreeUtils.cxx | 20 ++++++++------------
7 files changed, 39 insertions(+), 65 deletions(-)
diff --git a/tree/tree/src/TTreeCloner.cxx b/tree/tree/src/TTreeCloner.cxx
index 9bb24645ed8..acf13787d11 100644
--- a/tree/tree/src/TTreeCloner.cxx
+++ b/tree/tree/src/TTreeCloner.cxx
@@ -9,13 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TTreeCloner //
-// //
-// Class implementing or helping the various TTree cloning method //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TTreeCloner
+Class implementing or helping the various TTree cloning method
+*/
#include "TBasket.h"
#include "TBranch.h"
@@ -75,9 +71,10 @@ Bool_t TTreeCloner::CompareEntry::operator()(UInt_t i1, UInt_t i2)
/// the disk more often.
///
/// There is currently 3 supported sorting order:
-/// SortBasketsByOffset (the default)
-/// SortBasketsByBranch
-/// SortBasketsByEntry
+///
+/// SortBasketsByOffset (the default)
+/// SortBasketsByBranch
+/// SortBasketsByEntry
///
/// When using SortBasketsByOffset the baskets are written in
/// the output file in the same order as in the original file
@@ -99,7 +96,6 @@ Bool_t TTreeCloner::CompareEntry::operator()(UInt_t i1, UInt_t i2)
/// This means that on the file the baskets will be in the order
/// in which they will be needed when reading the whole tree
/// sequentially.
-///
TTreeCloner::TTreeCloner(TTree *from, TTree *to, Option_t *method, UInt_t options) :
fWarningMsg(),
diff --git a/tree/tree/src/TTreeResult.cxx b/tree/tree/src/TTreeResult.cxx
index dc4a4754bd4..b7ae1c6ff91 100644
--- a/tree/tree/src/TTreeResult.cxx
+++ b/tree/tree/src/TTreeResult.cxx
@@ -9,17 +9,13 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TTreeResult //
-// //
-// Class defining interface to a TTree query result with the same //
-// interface as for SQL databases. A TTreeResult is returned by //
-// TTree::Query() (actually TTreePlayer::Query()). //
-// //
-// Related classes are TTreeRow. //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TTreeResult
+Class defining interface to a TTree query result with the same
+interface as for SQL databases. A TTreeResult is returned by
+TTree::Query() (actually TTreePlayer::Query()).
+
+Related classes are TTreeRow.
+*/
#include "TTreeResult.h"
#include "TTreeRow.h"
diff --git a/tree/tree/src/TTreeRow.cxx b/tree/tree/src/TTreeRow.cxx
index b6b7e852769..4a7f52e104d 100644
--- a/tree/tree/src/TTreeRow.cxx
+++ b/tree/tree/src/TTreeRow.cxx
@@ -9,16 +9,12 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TTreeRow //
-// //
-// Class defining interface to a row of a TTree query result. //
-// Objects of this class are created by TTreeResult methods. //
-// //
-// Related classes are TTreeResult. //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TTreeRow
+Class defining interface to a row of a TTree query result.
+Objects of this class are created by TTreeResult methods.
+
+Related classes are TTreeResult.
+*/
#include "TTreeRow.h"
#include "TObjArray.h"
diff --git a/tree/tree/src/TTreeSQL.cxx b/tree/tree/src/TTreeSQL.cxx
index 9874e7a94dc..878926521e1 100644
--- a/tree/tree/src/TTreeSQL.cxx
+++ b/tree/tree/src/TTreeSQL.cxx
@@ -9,13 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TTreeSQL //
-// //
-// Implement TTree for a SQL backend //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TTreeSQL
+Implement TTree for a SQL backend
+*/
#include <Riostream.h>
#include <vector>
diff --git a/tree/tree/src/TVirtualIndex.cxx b/tree/tree/src/TVirtualIndex.cxx
index f039cb4d6b8..31f09225238 100644
--- a/tree/tree/src/TVirtualIndex.cxx
+++ b/tree/tree/src/TVirtualIndex.cxx
@@ -9,11 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// Abstract interface for Tree Index //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TVirtualIndex
+Abstract interface for Tree Index
+*/
#include "TVirtualIndex.h"
#include "TTree.h"
diff --git a/tree/tree/src/TVirtualTreePlayer.cxx b/tree/tree/src/TVirtualTreePlayer.cxx
index 3af12327480..460a6fc2889 100644
--- a/tree/tree/src/TVirtualTreePlayer.cxx
+++ b/tree/tree/src/TVirtualTreePlayer.cxx
@@ -9,15 +9,11 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TVirtualTreePlayer
-//
-// Abstract base class defining the interface for the plugins that
-// implement Draw, Scan, Process, MakeProxy, etc. for a TTree object.
-// See the individual documentations in TTree.
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TVirtualTreePlayer
+Abstract base class defining the interface for the plugins that
+implement Draw, Scan, Process, MakeProxy, etc. for a TTree object.
+See the individual documentations in TTree.
+*/
#include "TROOT.h"
#include "TVirtualTreePlayer.h"
diff --git a/tree/tree/src/TreeUtils.cxx b/tree/tree/src/TreeUtils.cxx
index 994d3eba1ae..17268f6f36b 100644
--- a/tree/tree/src/TreeUtils.cxx
+++ b/tree/tree/src/TreeUtils.cxx
@@ -9,14 +9,10 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TreeUtils //
-// //
-// Different standalone functions to work with trees and tuples, //
-// not reqiuired to be a member of any class. //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TreeUtils
+Different standalone functions to work with trees and tuples,
+not reqiuired to be a member of any class.
+*/
#include <istream>
#include <cassert>
@@ -237,7 +233,7 @@ template Long64_t FillNtupleFromStream<Double_t, TNtupleD>(std::istream &, TNtup
//newline-character:
// '\r' | '\n'
////////////////////////////////////////////////////////////////////////////////
-///Skips everything from '#' to (including) '\\r' or '\\n'.
+/// Skips everything from '#' to (including) '\\r' or '\\n'.
void SkipComment(std::istream &input)
{
@@ -256,7 +252,7 @@ void SkipComment(std::istream &input)
// ws-sequence newline-character
// ws-sequence comment
////////////////////////////////////////////////////////////////////////////////
-///Skips empty lines (newline-characters), ws-lines (consisting only of whitespace characters + newline-characters).
+/// Skips empty lines (newline-characters), ws-lines (consisting only of whitespace characters + newline-characters).
void SkipEmptyLines(std::istream &input)
{
@@ -277,7 +273,7 @@ void SkipEmptyLines(std::istream &input)
//ws-sequence:
// c such that isspace(c) and c is not a newline-character.
////////////////////////////////////////////////////////////////////////////////
-///Skip whitespace characters, but not newline-characters we support ('\\r' or '\\n').
+/// Skip whitespace characters, but not newline-characters we support ('\\r' or '\\n').
void SkipWSCharacters(std::istream &input)
{
@@ -295,7 +291,7 @@ void SkipWSCharacters(std::istream &input)
//Next character is either newline-character, eof or we have some problems reading
//the next symbol.
////////////////////////////////////////////////////////////////////////////////
-///Either '\\r' | '\\n' or eof of some problem.
+/// Either '\\r' | '\\n' or eof of some problem.
bool NextCharacterIsEOL(std::istream &input)
{
--
GitLab