[Insight-developers] Insight code walkthrough

Tue, 18 Sep 2001 17:22:20 -0400

--=====================_1232154093==_.ALT
Content-Type: text/plain; charset="us-ascii"

>    * We need to find a way to reduce the amount of whitespace in the header files.  Perhaps we can condense documentation before each method to a single line comment block or group typedefs so that they do not have a separate comment block (especially for typedefs that inherited from the superclass).  

This can be done most of the time, for example:

class ITK_EXPORT ObjectFactoryBase : public Object
{
public:  
  /**
   * Standard "Self" typedef.
   */
  typedef ObjectFactoryBase   Self;

  /**
   * Standard "Superclass" typedef.
   */
  typedef Object  Superclass;

/** 
 * Smart pointer typedef support.
 */
 typedef SmartPointer<Self> Pointer;
 typedef SmartPointer<const Self> ConstPointer;

  /**
   * Class Methods used to interface with the registered factories
   */

  /** 
   * Run-time type information (and related methods).
   */
  itkTypeMacro(ObjectFactoryBase, Object);

or 

class ITK_EXPORT ObjectFactoryBase : public Object
{
public:  
  ///! Standard "Self" typedef.
  typedef ObjectFactoryBase   Self;

  ///! Standard "Superclass" typedef.
  typedef Object  Superclass;

///!Smart pointer typedef support.
 typedef SmartPointer<Self> Pointer;
 typedef SmartPointer<const Self> ConstPointer;

  ///! Run-time type information (and related methods).
  itkTypeMacro(ObjectFactoryBase, Object);
--=====================_1232154093==_.ALT
Content-Type: text/html; charset="us-ascii"

<html>
<blockquote type=cite class=cite cite>
<ul>
<li>We need to find a way to reduce the amount of whitespace in the
header files.&nbsp; Perhaps we can condense documentation before each
method to a single line comment block or group typedefs so that they do
not have a separate comment block (especially for typedefs that inherited
from the superclass).&nbsp; </blockquote>
</ul> 
 
This can be done most of the time, for example: 
 
class ITK_EXPORT ObjectFactoryBase : public Object 
{ 
public:&nbsp; 
&nbsp; /** 
&nbsp;&nbsp; * Standard &quot;Self&quot; typedef. 
&nbsp;&nbsp; */ 
&nbsp; typedef ObjectFactoryBase&nbsp;&nbsp; Self; 
 
&nbsp; /** 
&nbsp;&nbsp; * Standard &quot;Superclass&quot; typedef. 
&nbsp;&nbsp; */ 
&nbsp; typedef Object&nbsp; Superclass; 
 
&nbsp; /** 
&nbsp;&nbsp; * Smart pointer typedef support. 
&nbsp;&nbsp; */ 
&nbsp; typedef SmartPointer&lt;Self&gt;&nbsp; Pointer; 
&nbsp; typedef SmartPointer&lt;const Self&gt;&nbsp; ConstPointer; 
 
&nbsp; /** 
&nbsp;&nbsp; * Class Methods used to interface with the registered
factories 
&nbsp;&nbsp; */ 
&nbsp; 
&nbsp; /** 
&nbsp;&nbsp; * Run-time type information (and related methods). 
&nbsp;&nbsp; */ 
&nbsp; itkTypeMacro(ObjectFactoryBase, Object); 
 
 
or 
 
class ITK_EXPORT ObjectFactoryBase : public Object 
{ 
public:&nbsp; 
&nbsp; ///! Standard &quot;Self&quot; typedef. 
&nbsp; typedef ObjectFactoryBase&nbsp;&nbsp; Self; 
 
&nbsp; ///! Standard &quot;Superclass&quot; typedef. 
&nbsp; typedef Object&nbsp; Superclass; 
 
&nbsp;&nbsp; ///!Smart pointer typedef support. 
&nbsp;&nbsp; typedef SmartPointer&lt;Self&gt;&nbsp; Pointer; 
&nbsp;&nbsp; typedef SmartPointer&lt;const Self&gt;&nbsp;
ConstPointer; 
 
&nbsp; ///! Run-time type information (and related methods). 
&nbsp; itkTypeMacro(ObjectFactoryBase, Object);</html>

--=====================_1232154093==_.ALT--