Headers comment (#342)

* added to autoclass doc

* added header

* file permission

* remove x permission

* spdhg x mode

* removed file

* reset permission to 644

5 files changed, 43 insertions, 0 deletions

diff --git a/docs/source/astra.rst b/docs/source/astra.rst
index 602ce31..b80d2a4 100644
--- a/docs/source/astra.rst
+++ b/docs/source/astra.rst
@@ -6,26 +6,35 @@ Processors
 
 .. autoclass:: ccpi.astra.processors.AstraBackProjector
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.processors.AstraBackProjector3D
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.processors.AstraBackProjectorMC
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.processors.AstraForwardProjector
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.processors.AstraForwardProjector3D
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.processors.AstraForwardProjectorMC
    :members:
+   :special-members:
 |
 
 Operators
 =========
 .. autoclass:: ccpi.astra.operators.AstraProjectorSimple
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.operators.AstraProjector3DSimple
    :members:
+   :special-members:
 .. autoclass:: ccpi.astra.operators.AstraProjectorMC
    :members:
+   :special-members:
 |
 
 
diff --git a/docs/source/contrib.rst b/docs/source/contrib.rst
index bc07fa1..336097e 100644
--- a/docs/source/contrib.rst
+++ b/docs/source/contrib.rst
@@ -8,6 +8,7 @@ Contributed by Dr. Matthias Ehrhardt.
 
 .. autoclass:: ccpi.contrib.optimisation.algorithms.spdhg.spdhg
    :members:
+   :special-members:
 |
 
 
diff --git a/docs/source/io.rst b/docs/source/io.rst
index 91ddcae..fb24a3a 100644
--- a/docs/source/io.rst
+++ b/docs/source/io.rst
@@ -6,14 +6,17 @@ NeXus
 
 .. autoclass:: ccpi.io.NEXUSDataReader
    :members:
+   :special-members:
 .. autoclass:: ccpi.io.NEXUSDataWriter
    :members:
+   :special-members:
 |
 
 Nikon
 =====
 .. autoclass:: ccpi.io.NikonDataReader
    :members:
+   :special-members:
 |
 
 
diff --git a/docs/source/optimisation.rst b/docs/source/optimisation.rst
index 51b6cc3..33bf376 100644
--- a/docs/source/optimisation.rst
+++ b/docs/source/optimisation.rst
@@ -67,28 +67,40 @@ forward and backprojection operations.
 
 .. autoclass:: ccpi.optimisation.operators.Operator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.LinearOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.ScaledOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.GradientOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.Identity
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.LinearOperatorMatrix
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.ShrinkageOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.SparseFiniteDiff
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.SymmetrizedGradientOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.ZeroOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.BlockOperator
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.operators.BlockScaledOperator
    :members:
+   :special-members:
 
 
 Function
@@ -110,24 +122,34 @@ e.g. :code:`f(x)` for a :code:`Function f` and input point :code:`x`.
 
 .. autoclass:: ccpi.optimisation.functions.Function
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.FunctionOperatorComposition
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.IndicatorBox
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.KullbackLeibler
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.L1Norm
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.L2NormSquared
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.MixedL21Norm
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.Norm2Sq
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.ScaledFunction
    :members:
+   :special-members:
 .. autoclass:: ccpi.optimisation.functions.ZeroFunction
    :members:
+   :special-members:
 
 
 :ref:`Return Home <mastertoc>`
diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst
index 8788db8..948980c 100644
--- a/docs/source/plugins.rst
+++ b/docs/source/plugins.rst
@@ -6,18 +6,23 @@ Operators
 
 .. autoclass:: ccpi.plugins.operators.CCPiProjectorSimple
    :members:
+   :special-members:
 |
 
 Processors
 ==========
 .. autoclass:: ccpi.plugins.processors.AcquisitionDataPadder
    :members:
+   :special-members:
 .. autoclass:: ccpi.plugins.processors.CCPiForwardProjector
    :members:
+   :special-members:
 .. autoclass:: ccpi.plugins.processors.CCPiBackwardProjector
    :members:
+   :special-members:
 .. autoclass:: ccpi.plugins.processors.setupCCPiGeometries
    :members:
+   :special-members:
 |
 
 Regularisers
@@ -25,10 +30,13 @@ Regularisers
 
 .. autoclass:: ccpi.plugins.regularisers.ROF_TV
    :members:
+   :special-members:
 .. autoclass:: ccpi.plugins.regularisers.FGP_TV
    :members:
+   :special-members:
 .. autoclass:: ccpi.plugins.regularisers.SB_TV
    :members:
+   :special-members:
 
 
 :ref:`Return Home <mastertoc>`