How to generate the document for interface only from .net project?

Hi Experts,

I am investigate the DOXYGEN tool to generate the document for C# project, I
have some questions:
1. How can I onfigure to generate the document for interface only (use
patterns, filter, ...?)
2. How can I remove the main page and replaced by the classes page as the
main page?
3. When I generate the classes, I want to split items in the list to 2
columns, namespace information as 1 column and class name as another column
instead of namespace and class name in 1 column.
Additional, how can I add the header column (caption) into the list (table)
of the classes page. For example, I want to show:

Namespace (title of column 1)               Class/Interface name (title of
column 2)
MySample.Classes                               MyClass1
MySample.Classes                               MyClass2
MySample.Interfaces                           IMyInterface

Thanks in advance for any attention on this topic.

Best regards

--

-- 
View this message in context: http://old.nabble.com/How-to-generate-the-document-for-interface-only-from-.net-project--tp33242564p33242564.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------

Deprecated classes

Hi, is it possible to set a property/flag about a class (in c++) that
is deprecated, and then having a css class on the generated html, so
that you style it differently?

------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2

Re: Deprecated classes

Am 05.02.2012 19:34, schrieb lecas malecas:
> Hi, is it possible to set a property/flag about a class (in c++) that
> is deprecated, and then having a css class on the generated html, so
> that you style it differently?
>

Quote from the "Special Commands" section of the doxygen manual:
 >>
\deprecated { description }

Starts a paragraph indicating that this documentation block belongs to a 
deprecated entity. Can be used to describe alternatives, expected life 
span, etc.
<<

There are already some settings in the style sheet for it too.

--
Stefan P.

Top-posting:
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,

groupgraph

------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2

_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Deprecated classes

Thanks, will try that.

On Mon, Feb 6, 2012 at 7:57 AM, Stefan Pendl <stefan.pendl.71 <at> gmail.com> wrote:
> Am 05.02.2012 19:34, schrieb lecas malecas:
>> Hi, is it possible to set a property/flag about a class (in c++) that
>> is deprecated, and then having a css class on the generated html, so
>> that you style it differently?
>>
>
> Quote from the "Special Commands" section of the doxygen manual:
>  >>
> \deprecated { description }
>
> Starts a paragraph indicating that this documentation block belongs to a
> deprecated entity. Can be used to describe alternatives, expected life
> span, etc.
> <<
>
> There are already some settings in the style sheet for it too.
>
>
> --
> Stefan P.
>
> Top-posting:
> A: Because it messes up the order in which people normally read text.
> Q: Why is top-posting such a bad thing?
> A: Top-posting.
> Q: What is the most annoying thing in e-mail?
>
> ------------------------------------------------------------------------------
> Try before you buy = See our experts in action!
> The most comprehensive online learning library for Microsoft developers
> is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
> Metro Style Apps, more. Free future releases when you subscribe now!
> http://p.sf.net/sfu/learndevnow-dev2
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
Try before you buy = See our experts in action!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-dev2

How to configure the layout for Class List page?

Hi Experts,

I am investigating DOXYGEN to generate the documentation for my example C#
source code. Below is the result of my Class List page layout:

Here are the classes, structs, unions and interfaces with brief
descriptions:
MyDocumentProject::BaseClases::BaseClass1	   BaseClass1,
MyDocumentProject::Class1	                           Inherit from BaseClass1
and extend methods
MyDocumentProject::Class2	                           Implement Class2

I want to split the namespace and class name to 2 columns and add the header
(caption) for this table. Below is the expected layout:

Here are the classes, structs, unions and interfaces with brief
descriptions:
Namespace                                         Class Name        Comment
MyDocumentProject::BaseClases       BaseClass1	         BaseClass1,
MyDocumentProject                        Class1	               Inherit from
BaseClass1 and extend methods
MyDocumentProject                        Class2	               Implement
Class2

How can I do that?

Thanks in advance for any attention on this topic

Regards

Thanh Vo

--

-- 
View this message in context: http://old.nabble.com/How-to-configure-the-layout-for-Class-List-page--tp33283287p33283287.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

What's the best way to build doxygen 32-bit on a 64-bit platform?

Normally I'd try something like:

CFLAGS=-m32 CXXFLAGS=-m32 ./configure <args>

But that isn't a "normal" AC script.

Any suggestions, or should I just hack the makefiles ?

thanks,

A.

--

-- 
Alun Evans

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

documented function `' was not declared or defined bug?

Hi,
I'd like to ask if following doxygen behaviour is a bug?

Let's have two files myclass.h and myclass.cc.
--------------------
#ifndef MYCLASS_INCLUDED
#define MYCLASS_INCLUDED  ///< Multiple inclusion protection.

/**
 * @brief Documentation of class.
 */
class MyClass
{
  public:
    /**
     * @brief Documentation of method.
     * @param myParameter Documentation of parameter.
     */
    void myMethod(unsigned int);

  private:
    unsigned myProperty;  ///< Documentation of property.
};

#endif  // MYCLASS_INCLUDED
--------------------
#include "myclass.h"

void MyClass::myMethod(unsigned myParameter)
{
    myProperty = myParameter;
}

int main()
{
    MyClass myClass;
    myClass.myMethod(1);
}
--------------------

doxygen --version
1.7.6.1

doxygen -g
Only one edit of Doxyfile: EXTRACT_ALL = YES

doxygen
...
/home/mermar/test/myclass.cc:4: warning: documented function `void MyClass::myMethod' was not
declared or defined.
...

The code seems OK. In HTML output, there is no class, no method. Is there something wrong with my documentation?

Best regards
Martin

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

Re: documented function `' was not declared or definedbug?

Try adding

/** @file */

to the top of your header file.

Greg.

-----Original Message-----
From: mermar <at> centrum.cz [mailto:mermar <at> centrum.cz] 
Sent: 08 February 2012 09:17
To: doxygen-users <at> lists.sourceforge.net
Subject: [Doxygen-users] documented function `' was not declared or
definedbug?

Hi,
I'd like to ask if following doxygen behaviour is a bug?

Let's have two files myclass.h and myclass.cc.
--------------------
#ifndef MYCLASS_INCLUDED
#define MYCLASS_INCLUDED  ///< Multiple inclusion protection.

/**
 * @brief Documentation of class.
 */
class MyClass
{
  public:
    /**
     * @brief Documentation of method.
     * @param myParameter Documentation of parameter.
     */
    void myMethod(unsigned int);

  private:
    unsigned myProperty;  ///< Documentation of property.
};

#endif  // MYCLASS_INCLUDED
--------------------
#include "myclass.h"

void MyClass::myMethod(unsigned myParameter)
{
    myProperty = myParameter;
}

int main()
{
    MyClass myClass;
    myClass.myMethod(1);
}
--------------------

doxygen --version
1.7.6.1

doxygen -g
Only one edit of Doxyfile: EXTRACT_ALL = YES

doxygen
...
/home/mermar/test/myclass.cc:4: warning: documented function `void
MyClass::myMethod' was not declared or defined. ...

The code seems OK. In HTML output, there is no class, no method. Is
there something wrong with my documentation?

Best regards
Martin

------------------------------------------------------------------------
------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
****************************************************
Visit our website at http://www.domino-printing.com
****************************************************
This Email and any files transmitted with it are intended only for the person or entity to which it is
addressed and may contain confidential and/or privileged material. Any reading, redistribution,
disclosure or other use of, or taking of any action in reliance upon, this information by persons or
entities other than the intended recipient is prohibited.  If you are not the intended recipient please
contact the sender immediately and delete the material from your computer.

E-mail may be susceptible to data corruption, interception, viruses and unauthorised amendment and
Domino UK Limited does not accept liability for any such corruption, interception, viruses or amendment
or their consequences.
****************************************************
Domino UK Limited. Registered in England. Registered Number:1750201. Registered Office Address:
Trafalgar Way, Bar Hill, Cambridge, CB23 8TU.

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d

Re: documented function `' was not declared or defined bug?

Hi Martin,

I didn't get this warning, but try replacing

void MyClass::myMethod(unsigned myParameter)

with

void MyClass::myMethod(unsigned int myParameter)

so it matches the declaration.

Regards,
  Dimitri

On Feb 8, 2012, at 10:17 , <mermar <at> centrum.cz> <mermar <at> centrum.cz> wrote:

> 
> Hi,
> I'd like to ask if following doxygen behaviour is a bug?
> 
> Let's have two files myclass.h and myclass.cc.
> --------------------
> #ifndef MYCLASS_INCLUDED
> #define MYCLASS_INCLUDED  ///< Multiple inclusion protection.
> 
> /**
> * @brief Documentation of class.
> */
> class MyClass
> {
>  public:
>    /**
>     * @brief Documentation of method.
>     * @param myParameter Documentation of parameter.
>     */
>    void myMethod(unsigned int);
> 
>  private:
>    unsigned myProperty;  ///< Documentation of property.
> };
> 
> #endif  // MYCLASS_INCLUDED
> --------------------
> #include "myclass.h"
> 
> void MyClass::myMethod(unsigned myParameter)
> {
>    myProperty = myParameter;
> }
> 
> int main()
> {
>    MyClass myClass;
>    myClass.myMethod(1);
> }
> --------------------
> 
> doxygen --version
> 1.7.6.1
> 
> doxygen -g
> Only one edit of Doxyfile: EXTRACT_ALL = YES
> 
> doxygen
> ...
> /home/mermar/test/myclass.cc:4: warning: documented function `void MyClass::myMethod' was not
declared or defined.
> ...
> 
> The code seems OK. In HTML output, there is no class, no method. Is there something wrong with my documentation?
> 
> Best regards
> Martin
> 
> ------------------------------------------------------------------------------
> Keep Your Developer Skills Current with LearnDevNow!
> The most comprehensive online learning library for Microsoft developers
> is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
> Metro Style Apps, more. Free future releases when you subscribe now!
> http://p.sf.net/sfu/learndevnow-d2d
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d