[Insight-developers] doxygen warnings

[Bill Hoffman]

There was one formula that was bad in a .h file.   Once there is an error
on latex, that is the end of it...   Doxygen collects up all the formulas, and
puts them in a single latex file, then runs latex on the single file, and if it
has an error, you are out of luck.

-Bill


At 10:41 AM 4/15/2002 -0600, Joshua Cates wrote:
>Hi Will,
>
>This reminds me: the LaTeX equations are no longer being generated on the
>Itk doxygen webpages.  It seems like they were working at one time.
>
>Josh.
>
>______________________________
> Josh Cates
> School of Computer Science
> University of Utah
> Email: cates@cs.utah.edu
> Phone: (801) 587-7697
> URL:   www.cs.utk.edu/~cates
>
>
>On Fri, 12 Apr 2002, Will Schroeder wrote:
>
>> Hi Aljaz -
>>
>> We believe that we tracked down the problems with the Doxygen warnings. The
>> doxygen.config file was set up to process .h, .txx, and .cxx files. You had
>> all sorts of weird Doxygen-like comments in the .cxx source code, so
>> Doxygen was getting confused. We removed the processing of .cxx and .txx
>> files, i.e., only .h source files are processed. You shouldn't have to do
>> anything.
>>
>> Will
>>
>> At 01:56 PM 4/12/2002 -0400, Aljaz Noe wrote:
>> >Hi!
>> >
>> >I've noticed a lot of doxygen warnings in both FEM and other files. Since
>> >we'll have to rewrite the whole FEM library in the near future, it would be
>> >nice to know how to correct for these warnings as well.
>> >
>> >Typical warning from the FEM code:
>> >------------------------------
>> >
>> >/mounts/raid/projects/Insight/Testing/Insight/Code/Numerics/FEM/itkFEMElemen
>> >tBar2D.cxx:43: Warning: @{ may only be used in a group block!
>> >
>> >
>> ><<itkFEMElementBar2D.cxx>>
>> >...
>> >/**
>> >  * Construct a Bar2D element by specifying two nodes and material
>> >propertites
>> >  */
>> >Bar2D::Bar2D( Node::ConstPointer n1_, Node::ConstPointer n2_,
>> >Material::ConstPointer const mat_ )
>> >{
>> >  /**
>> ><<line 43>>   * Initialize the pointers to nodes and check that
>> >    * we were given the pointers to the right node class.
>> >    * if the node class was incorrect a bad_cast exception is thrown
>> >    */
>> >   try
>> >   {
>> >     m_node[0]=&dynamic_cast<const NodeXY&>(*n1_);
>> >     m_node[1]=&dynamic_cast<const NodeXY&>(*n2_);
>> >     m_mat=&dynamic_cast<const MaterialStandard&>(*mat_);
>> >   }
>> >   catch ( std::bad_cast )
>> >   {
>> >     throw FEMExceptionWrongClass(__FILE__,__LINE__,"Bar2D::Bar2D()");
>> >   }
>> >
>> >}
>> >...
>> >
>> >------------------------------
>> >
>> >/mounts/raid/projects/Insight/Testing/Insight/Code/Numerics/FEM/itkFEMLoadGr
>> >av.h:66: Warning: end of group without matching begin.
>> >
>> >
>> >
>> ><<itkFEMLoadGrav.h>>
>> >...
>> >/**
>> >  * \class LoadGravConst
>> >  * \brief Constant gravity load class.
>> >  *
>> >  * This is a special case of LoadGrav. The load vector is the same on
>> >  * every point in space.
>> >  */
>> >class LoadGravConst : public LoadGrav
>> >{
>> >FEM_CLASS(LoadGravConst,LoadGrav)
>> >public:
>> >   vnl_vector<Float> Fg_value;
>> >   virtual vnl_vector<Float> Fg(vnl_vector<Float>) {
>> >     return Fg_value;
>> >   };
>> ><<line 66>>
>> >   /**
>> >    * Read an object from input stream.
>> >    */
>> >   virtual void Read( std::istream& f, void* info );
>> >
>> >   /**
>> >    * Write an object to the output stream
>> >    */
>> >   virtual void Write( std::ostream& f, int ofid ) const;
>> >
>> >};
>> >
>> >-------------------------------
>> >
>> >It looks like the perl script, which does the preprocessing, sometimes gets
>> >stuck on doxygen comments (/**). I don't know, however, what is the real
>> >cause and what is the proper way to correct the problem.
>> >
>> >Aljaz
>> >
>> >_______________________________________________
>> >Insight-developers mailing list
>> >Insight-developers@public.kitware.com
>> >http://public.kitware.com/mailman/listinfo/insight-developers
>>
>> _______________________________________________
>> Insight-developers mailing list
>> Insight-developers@public.kitware.com
>> http://public.kitware.com/mailman/listinfo/insight-developers
>>
>
>_______________________________________________
>Insight-developers mailing list
>Insight-developers@public.kitware.com
>http://public.kitware.com/mailman/listinfo/insight-developers