From 323017e782afd3d5f8861fb02de8d38e2e7c243a Mon Sep 17 00:00:00 2001 From: Sergey Linev Date: Wed, 29 Jan 2025 12:52:21 +0100 Subject: [PATCH] Finish plugin doc formating --- plugins/fesa/Readme.md | 2 +- plugins/gosip/Readme.md | 15 +++++++++------ plugins/mbs-root/Readme.md | 21 +++++++++------------ plugins/rfio/Readme.md | 10 +++------- plugins/root/Readme.md | 12 +++++------- plugins/saft/Readme.md | 15 ++++++--------- plugins/stream/Readme.md | 6 ++---- plugins/user/Readme.md | 6 ++---- plugins/verbs/Readme.md | 6 ++---- 9 files changed, 39 insertions(+), 54 deletions(-) diff --git a/plugins/fesa/Readme.md b/plugins/fesa/Readme.md index 0849bc68..4b6cc5d9 100644 --- a/plugins/fesa/Readme.md +++ b/plugins/fesa/Readme.md @@ -1,4 +1,4 @@ -\page fesa_plugin %FESA plugin for %DABC (libDabcFesa.so) +\page fesa_plugin FESA plugin for DABC (libDabcFesa.so) \subpage fesa_plugin_doc diff --git a/plugins/gosip/Readme.md b/plugins/gosip/Readme.md index b9ff66e2..75777104 100644 --- a/plugins/gosip/Readme.md +++ b/plugins/gosip/Readme.md @@ -1,9 +1,12 @@ \page gosip_plugin GOSIP plugin for DABC (libDabcGosip.so) -\subpage gosip_plugin_doc - \ingroup dabc_plugins +\subpage gosip_plugin_doc
+ +\subpage gosip_rgoc_doc
+ + \page gosip_plugin_doc Short description of GOSIP plugin @@ -32,10 +35,10 @@ GosipCommandServer 0.139443 Starting GOSIP command server module -## Usage of rgoc +\page gosip_rgoc_doc Usage of rgoc -``` +~~~~~~~~~~ *************************************************************************** rgoc (remote gosipcmd) for dabc and mbspex library v0.3 07-Dec-2022 by JAM (j.adamczewski@gsi.de) @@ -79,12 +82,12 @@ GosipCommandServer 0.139443 Starting GOSIP command server module rgoc -u x86l-113 0 0 0x200000 0x4 0xFF : unset bit 100 on sfp0, slave 0, address 0x200000-0x2000FF rgoc -x -c x86l-113 run42.gos : write configuration values from file run42.gos to slaves ***************************************************************************** -``` +~~~~~~~~~~ ## Compilation To enable compilation of gosip plugin, select the flag in cmake configuration like: - cmake -Dgosip=on + cmake -Dgosip=on The TerminalModule requires to link against `libmbspex.so`. The rgoc command line tool works independently from any hardware driver library. diff --git a/plugins/mbs-root/Readme.md b/plugins/mbs-root/Readme.md index 39adfd0c..421c6e2c 100644 --- a/plugins/mbs-root/Readme.md +++ b/plugins/mbs-root/Readme.md @@ -1,13 +1,10 @@ -\page mbs_root_plugin -## ROOT-MBS plugin for DABC (libDabcMbsRoot.so) +\page mbs_root_plugin ROOT-MBS plugin for DABC (libDabcMbsRoot.so) \ingroup dabc_plugins \subpage mbs_root_plugin_doc -\page mbs_root_plugin_doc - -# Info about ROOT-MBS plugin +\page mbs_root_plugin_doc Info about ROOT-MBS plugin Version 0.9 September 2010 by Ahl Balitaon, Joern Adamczewski-Musch @@ -21,13 +18,13 @@ Example file RocReadout.xml shows how parameters for plug-in are set which are passed via CreateTransport in the CreateAppModules() of the dabc application: -~~~~~{.xml} - - - - - -~~~ +~~~~~~~~ + + + + + +~~~~~~~~ Note that tag CalibrFile is part of the ROC example, not part of the plug-in. diff --git a/plugins/rfio/Readme.md b/plugins/rfio/Readme.md index 2b407610..af43ba12 100644 --- a/plugins/rfio/Readme.md +++ b/plugins/rfio/Readme.md @@ -1,15 +1,11 @@ -\page rfio_plugin - -## RFIO plugin for DABC (libDabcRfio.so) +\page rfio_plugin RFIO plugin for DABC (libDabcRfio.so) \subpage rfio_plugin_doc \ingroup dabc_plugins -\page rfio_plugin_doc - -# Short description of RFIO plugin {#rfio_plugin_doc} +\page rfio_plugin_doc Short description of RFIO plugin ## Introduction Plugin provides implementation of dabc::FileInterface class for @@ -26,4 +22,4 @@ ADSMDIR should contain necessary includes and librawapiclin64.a. To disable plugin compilation, norfio variable should be specified: - make norfio=1 + cmake .. -Drfio=OFF diff --git a/plugins/root/Readme.md b/plugins/root/Readme.md index 8c4f7758..26610821 100644 --- a/plugins/root/Readme.md +++ b/plugins/root/Readme.md @@ -1,17 +1,15 @@ -\page root_plugin -## ROOT plugin for DABC (libDabcRoot.so) +\page root_plugin ROOT plugin for DABC (libDabcRoot.so) \ingroup dabc_plugins -\subpage root_readme +\subpage root_readme
-[JavaScript ROOT](https://github.com/root-project/jsroot/blob/master/docs/JSROOT.md) +[JavaScript ROOT](https://github.com/root-project/jsroot/blob/master/docs/JSROOT.md)
-[THttpServer](https://github.com/root-project/jsroot/blob/master/docs/HttpServer.md) +[THttpServer](https://github.com/root-project/jsroot/blob/master/docs/HttpServer.md)
-\page root_readme -# Use of ROOT plugin {#root_readme} +\page root_readme Use of ROOT plugin ## Introduction diff --git a/plugins/saft/Readme.md b/plugins/saft/Readme.md index 849f2386..759e314b 100644 --- a/plugins/saft/Readme.md +++ b/plugins/saft/Readme.md @@ -1,14 +1,11 @@ -\page saft_plugin - -## Simplified API For Timing (SAFT)plugin for DABC (libDabcSaft.so) +\page saft_plugin Simplified API For Timing (SAFT)plugin for DABC (libDabcSaft.so) \subpage saft_plugin_doc \ingroup dabc_plugins -\page saft_plugin_doc -# Short description of SAFT plugin {#saft_plugin_doc} +\page saft_plugin_doc Short description of SAFT plugin ## Compilation Saftlib installation can be done as described at @@ -27,7 +24,7 @@ To disable compilation of SAFT plugin, call ## Usage -1)Please adjust the configuration file SaftRead.xml to match the White Rabbit events to monitor. +1. Please adjust the configuration file SaftRead.xml to match the White Rabbit events to monitor. This can be either latched pulses on the named Timing Receiver Inputs (e.g. "IO2" on EXPLODER5a), or White Rabbit events received over the timing network. The first case is defined by entries in tag ``. @@ -35,7 +32,7 @@ The second case can be specified by tags `` with corresponding order event id, mask, offset and flags. -2) Start DABC data capturing from timing receiver by +2. Start DABC data capturing from timing receiver by dabc_run SaftRead.xml @@ -45,7 +42,7 @@ Can be inspected/printed with go4analysis -print -stream localhost:6111. -3) optional Go4 analysis for SAFT data +3. Optional Go4 analysis for SAFT data Subdirectory plugins/saft/go4 contains simple analysis, which can monitor the dataas provided by saftplugin. Just configure Go4 environment (via '. go4login') and call make in the directory @@ -59,7 +56,7 @@ of rising and falling edges ("LostEdges"). Additionally, the delta timestamps of "DeltaT" (execution time), "DeltaT_deadline" and "DeltaT_deadline_fine" (deadline time). Note that for input latch the deadline time denotes the arrival time of the input, not the execution time! -\author JAM(j.adamczewski@gsi.de) +\author JAM(j.adamczewski(at)gsi.de) \date 15-September-2016 diff --git a/plugins/stream/Readme.md b/plugins/stream/Readme.md index 3cb9a0fe..f171501c 100644 --- a/plugins/stream/Readme.md +++ b/plugins/stream/Readme.md @@ -1,13 +1,11 @@ -\page stream_plugin -## Stream plugin for DABC (libDabcStream.so) +\page stream_plugin Stream plugin for DABC (libDabcStream.so) \ingroup dabc_plugins \subpage stream_plugin_doc -\page stream_plugin_doc -# Stream usage with DABC {#stream_plugin_doc} +\page stream_plugin_doc Stream usage with DABC Implements following classes: diff --git a/plugins/user/Readme.md b/plugins/user/Readme.md index dc5fdbf2..878a29b0 100644 --- a/plugins/user/Readme.md +++ b/plugins/user/Readme.md @@ -1,13 +1,11 @@ -\page user_plugin -## User readout plugin for DABC (libDabcUser.so) +\page user_plugin User readout plugin for DABC (libDabcUser.so) \subpage user_plugin_doc \ingroup dabc_plugins -\page user_plugin_doc -# Example of a user defined readout plugin {#user_plugin_doc} +\page user_plugin_doc Example of a user defined readout plugin ## Introduction diff --git a/plugins/verbs/Readme.md b/plugins/verbs/Readme.md index 4ad36c2d..7e0ace86 100644 --- a/plugins/verbs/Readme.md +++ b/plugins/verbs/Readme.md @@ -1,13 +1,11 @@ -\page verbs_plugin -## Verbs plugin for DABC (libDabcVerbs.so) +\page verbs_plugin Verbs plugin for DABC (libDabcVerbs.so) \subpage verbs_plugin_doc \ingroup dabc_plugins -\page verbs_plugin_doc -# Infiniband support for DABC {#verbs_plugin_doc} +\page verbs_plugin_doc Infiniband support for DABC Implements following classes: