fenics team mailing list archive

[Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>]

On 30 August 2010 12:55,  <noreply@xxxxxxxxxxxxx> wrote:
> ------------------------------------------------------------
> revno: 106
> committer: Anders Logg <logg@xxxxxxxxx>
> branch nick: fenics-doc
> timestamp: Mon 2010-08-30 12:52:08 +0200
> message:
>  Remove "inline" and "virtual" since Sphinx seems to not be able to handle them

And '~' is not handled either.

Kristian

> modified:
>  source/programmers-reference/cpp/la/Vector.rst
>  utils/generate_cpp_doc.py
>
>
> --
> lp:fenics-doc
> https://code.launchpad.net/~fenics-core/fenics-doc/main
>
> You are subscribed to branch lp:fenics-doc.
> To unsubscribe from this branch go to https://code.launchpad.net/~fenics-core/fenics-doc/main/+edit-subscription
>
> === modified file 'source/programmers-reference/cpp/la/Vector.rst'
> --- source/programmers-reference/cpp/la/Vector.rst      2010-08-30 10:48:26 +0000
> +++ source/programmers-reference/cpp/la/Vector.rst      2010-08-30 10:52:08 +0000
> @@ -19,6 +19,14 @@
>     This class provides the default DOLFIN vector class,
>     based on the default DOLFIN linear algebra backend.
>
> +    .. cpp:function:: GenericVector* instance()
> +
> +        Return concrete instance / unwrap (non-const version)
> +
> +    .. cpp:function:: LinearAlgebraFactory& factory() const
> +
> +        Return linear algebra backend factory
> +
>     .. cpp:function:: Vector()
>
>         Create empty vector
> @@ -31,147 +39,139 @@
>
>         Copy constructor
>
> -    .. cpp:function:: const Vector& operator= (const Vector& x)
> -
> -        Assignment operator
> -
> -    .. cpp:function:: const Vector& operator= (double a)
> -
> -        Assignment operator
> -
> -    .. cpp:function:: explicit Vector(uint N)
> -
> -        Create vector of size N
> -
> -    .. cpp:function:: virtual GenericVector* instance()
> -
> -        Return concrete instance / unwrap (non-const version)
> -
> -    .. cpp:function:: virtual LinearAlgebraFactory& factory() const
> -
> -        Return linear algebra backend factory
> -
> -    .. cpp:function:: virtual Vector* copy() const
> +    .. cpp:function:: Vector* copy() const
>
>         Return copy of tensor
>
> -    .. cpp:function:: virtual const GenericVector& operator= (const GenericVector& x)
> +    .. cpp:function:: const GenericVector& operator= (const GenericVector& x)
>
>         Assignment operator
>
> -    .. cpp:function:: virtual const GenericVector* instance() const
> +    .. cpp:function:: const GenericVector* instance() const
>
>         Return concrete instance / unwrap (const version)
>
> -    .. cpp:function:: virtual const Vector& operator*= (const GenericVector& x)
> +    .. cpp:function:: const Vector& operator*= (const GenericVector& x)
>
>         Multiply vector by another vector pointwise
>
> -    .. cpp:function:: virtual const Vector& operator*= (double a)
> +    .. cpp:function:: const Vector& operator*= (double a)
>
>         Multiply vector by given number
>
> -    .. cpp:function:: virtual const Vector& operator+= (const GenericVector& x)
> +    .. cpp:function:: const Vector& operator+= (const GenericVector& x)
>
>         Add given vector
>
> -    .. cpp:function:: virtual const Vector& operator-= (const GenericVector& x)
> +    .. cpp:function:: const Vector& operator-= (const GenericVector& x)
>
>         Subtract given vector
>
> -    .. cpp:function:: virtual const Vector& operator/= (double a)
> +    .. cpp:function:: const Vector& operator/= (double a)
>
>         Divide vector by given number
>
> -    .. cpp:function:: virtual const double* data() const
> +    .. cpp:function:: const Vector& operator= (const Vector& x)
> +
> +        Assignment operator
> +
> +    .. cpp:function:: const Vector& operator= (double a)
> +
> +        Assignment operator
> +
> +    .. cpp:function:: const double* data() const
>
>         Return pointer to underlying data (const version)
>
> -    .. cpp:function:: virtual double inner(const GenericVector& x) const
> +    .. cpp:function:: double inner(const GenericVector& x) const
>
>         Return inner product with given vector
>
> -    .. cpp:function:: virtual double max() const
> +    .. cpp:function:: double max() const
>
>         Return maximum value of vector
>
> -    .. cpp:function:: virtual double min() const
> +    .. cpp:function:: double min() const
>
>         Return minimum value of vector
>
> -    .. cpp:function:: virtual double norm(std
> +    .. cpp:function:: double norm(std
>
>         Return norm of vector
>
> -    .. cpp:function:: virtual double sum() const
> +    .. cpp:function:: double sum() const
>
>         Return sum of values of vector
>
> -    .. cpp:function:: virtual double* data()
> +    .. cpp:function:: double* data()
>
>         Return pointer to underlying data
>
> -    .. cpp:function:: virtual std
> +    .. cpp:function:: explicit Vector(uint N)
> +
> +        Create vector of size N
> +
> +    .. cpp:function:: std
>
>         Return informal string representation (pretty-print)
>
> -    .. cpp:function:: virtual std
> +    .. cpp:function:: std
>
>         Return local ownership range of a vector
>
> -    .. cpp:function:: virtual uint size() const
> +    .. cpp:function:: uint size() const
>
>         Return size of vector
>
> -    .. cpp:function:: virtual void add(const double* block, uint m, const uint* rows)
> +    .. cpp:function:: void add(const double* block, uint m, const uint* rows)
>
>         Add block of values
>
> -    .. cpp:function:: virtual void add_local(const Array<double>& values)
> +    .. cpp:function:: void add_local(const Array<double>& values)
>
>         Add values to each entry on local process
>
> -    .. cpp:function:: virtual void apply(std
> +    .. cpp:function:: void apply(std
>
>         Finalize assembly of tensor
>
> -    .. cpp:function:: virtual void axpy(double a, const GenericVector& x)
> +    .. cpp:function:: void axpy(double a, const GenericVector& x)
>
>         Add multiple of given vector (AXPY operation)
>
> -    .. cpp:function:: virtual void gather(GenericVector& x, const Array<uint>& indices) const
> +    .. cpp:function:: void gather(GenericVector& x, const Array<uint>& indices) const
>
>         Gather entries into local vector x
>
> -    .. cpp:function:: virtual void get(double* block, uint m, const uint* rows) const
> +    .. cpp:function:: void get(double* block, uint m, const uint* rows) const
>
>         Get block of values
>
> -    .. cpp:function:: virtual void get_local(Array<double>& values) const
> +    .. cpp:function:: void get_local(Array<double>& values) const
>
>         Get all values on local process
>
> -    .. cpp:function:: virtual void get_local(double* block, uint m, const uint* rows) const
> +    .. cpp:function:: void get_local(double* block, uint m, const uint* rows) const
>
>         Get block of values (values must all live on the local process)
>
> -    .. cpp:function:: virtual void resize(uint N)
> +    .. cpp:function:: void resize(uint N)
>
>         Resize vector to size N
>
> -    .. cpp:function:: virtual void set(const double* block, uint m, const uint* rows)
> +    .. cpp:function:: void set(const double* block, uint m, const uint* rows)
>
>         Set block of values
>
> -    .. cpp:function:: virtual void set_local(const Array<double>& values)
> +    .. cpp:function:: void set_local(const Array<double>& values)
>
>         Set all values on local process
>
> -    .. cpp:function:: virtual void zero()
> +    .. cpp:function:: void zero()
>
>         Set all entries to zero and keep any sparse structure
>
> -    .. cpp:function:: virtual ~Vector()
> +    .. cpp:function:: ~Vector()
>
>         Destructor
>
>
> === modified file 'utils/generate_cpp_doc.py'
> --- utils/generate_cpp_doc.py   2010-08-30 10:48:26 +0000
> +++ utils/generate_cpp_doc.py   2010-08-30 10:52:08 +0000
> @@ -104,6 +104,10 @@
>                 signature = signature.split(":")[0]
>                 signature = signature.strip()
>
> +                # Remove stuff Spinx can't handle
> +                signature = signature.replace("virtual ", "")
> +                signature = signature.replace("inline ", "")
> +
>                 # Get function name
>                 #function = signature.split("(")[0].split(" ")[-1]
>
> @@ -130,8 +134,8 @@
>     "Write documentation for given header in given module"
>
>     # For quick testing
> -    #if not header == "Vector.h":
> -    #    return
> +    if not header == "Vector.h":
> +        return
>
>     print "Writing documentation for %s..." % header
>
>
>
>