--- PamCut/doc/PamCutDevGuide.tex 2009/10/27 10:24:36 1.5 +++ PamCut/doc/PamCutDevGuide.tex 2009/10/28 14:52:29 1.6 @@ -130,7 +130,7 @@ event. If a certain cut in a bunch fails, then {\bf OnBad} is called for the actions of the bunch, but successive bunches are ignored; the current event is discarded and the focus switches on the next one (the {\bf -SmartBlindCollection} behaves a little different; see the Doxygen +SmartBlindCollection} behaves a little differently; see the Doxygen documentation for more details.) \\ Loosely speaking, after defining an action one simply has to instantiate it, @@ -292,7 +292,7 @@ \verb1 http://www.stack.nl/~dimitri/doxygen/manual.html1 \vspace{.5cm} -Once the header has been prepared, it's time to implement the cut into {\it +Once the header has been prepared, it's time to implement the cut in {\it DummyCut.cpp}: \begin{verbatim} @@ -584,9 +584,12 @@ PamCutCollection collection("Collection"); - DummyCut1 dummy1; + DummyCut1 *dummy1 = new DummyCut1("name1"); collection.AddCut(dummy1); - DummyCut2 dummy2(param); + // The two lines above can be summarized also as: + // collection.AddCut(new DummyCut1("name1")); + + DummyCut2 *dummy2 = new DummyCut2("name2", ); collection.AddCut(dummy2); collection.Process(event, 0, event->GetEntries()-1); @@ -646,13 +649,13 @@ be automatically executed every time you set your PAMELA environment. \section{Usage summary} -Here's a short summary on how to develop a cut, build and use it. If one only +Here's a short summary on how to develop a cut, build and use it. \begin{enumerate} \item Obtain the code (from tarball, repository\ldots) and go in the root code directory. \item Check if the \verb1C++1 option in the Build section of {\it makefile} is correctly set with the C++ compiler name present in your system (for many - Linux platform, \verb1g++1 is a safe choice). + Linux platforms, \verb1g++1 is a safe choice). \item Create a directory named as the cut class you want to develop. \item Place inside the newly created directory a {\it .h} file and a {\it .cpp} file, named as the direcory; edit the files to define and implement the @@ -676,6 +679,19 @@ \item Develop the analysis code \end{enumerate} +\section{Online documentation} +The code is provided with a full set of Doxygen tags; documentation can then be +built using the doxygen documentation system. However, an online documentation +is availbale at: +\newline +\newline +\verb1 http://hep.fi.infn.it/PAMELA/documents/PamCut_documentation/1 + +\vspace{.5cm} +It is updated frequently, but it may lack the description of the most recent +features. Please notify any fault in the online documentation for a quick fix. + + \section{Some advices and suggestions} \begin{itemize} \item Derive your cuts. Try to define a new class every time you need a new @@ -726,7 +742,7 @@ likely to be used and modified by other people, please take your time to write the documentation. Documenting the code is a boring and time-consuming task, but can save you and your colleagues a lot of headaches and - misunderstandings. The better a code is documented, the lesser are the + misunderstandings. The better a code is documented, the lesser the questions other people will ask you. \end{itemize}