- added documentation for the idx, coloridx and lorentzidx classes

[ginac.git] / ginac / coloridx.h

diff --git a/ginac/coloridx.h b/ginac/coloridx.h
index 78bd356a3b2cce88ae6c0c83c9f49b4858193b96..ad190c1181536199a2b479241f6da98c4967df57 100644 (file)
--- a/ginac/coloridx.h
+++ b/ginac/coloridx.h
@@ -32,6 +32,8 @@
 namespace GiNaC {
 #endif // ndef NO_NAMESPACE_GINAC
 
+/** Class of indices for color algebra (SU(3)) objects, to tell them apart
+ *  from other index families like Lorentz indices. */
 class coloridx : public idx
 {
        GINAC_DECLARE_REGISTERED_CLASS(coloridx, idx)