Styjun

What is the meaning of "it" in "as luck would have it"?

Tricolour nonogram

Why doesn't SpaceX land boosters in Africa?

Multiple tests with effects all in same direction but only few significant

Why isn't UDP with reliability (implemented at Application layer) a substitute of TCP?

Having to constantly redo everything because I don't know how to do it

Could you fall off a planet if it was being accelerated by engines?

How useful would a hydroelectric power plant be in the post-apocalypse world?

Angle Between Two Vectors Facing A Point

Why are symbols not written in words?

My mom helped me cosign a car and now she wants to take it

What is this fluorinated organic substance?

Why are examinees often not allowed to leave during the start and end of an exam?

Is there a word for the act of simultaneously pulling and twisting an object?

How to count the number of bytes in a file, grouping the same bytes?

How to stop QGIS from looking for the wrong PostgreSQL host address in an existing workproject?

Did NASA distinguish between the space shuttle cockpit and flight deck?

Odd PCB Layout for Voltage Regulator

How can this fractal shape perfectly cover a certain platonic solid?

Do electrons really perform instantaneous quantum leaps?

Understanding the as-if rule, "the program was executed as written"

What could a Medieval society do with excess animal blood?

What happens if a caster is surprised while casting a spell with a long casting time?

How to track mail undetectably?

How to tell doxygen to use /** as class doc instead /*! class

How can I prevent SQL injection in PHP?How do I get PHP errors to display?How do I get a YouTube video thumbnail from the YouTube API?How do you parse and process HTML/XML in PHP?How do I check if a string contains a specific word?Structuring documentation when using DoxygenHow does PHP 'foreach' actually work?Objective-C Documentation Generators: HeaderDoc vs. Doxygen vs. AppleDocHow do I include multiple paragraphs in the “remarks” section using Doxygen?How to use Doxygen and Doxygen::Filter::Perl to generate documentation for Perl sub routines?

1

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style:

/**
 * DESCRIPTION
 *
 * @category PHP
 * @package UserManagement.Class
 * @author Name <email@company.com>
 * @copyright 2011 Company
 * @link http://www.company.com
 */

but doxygen does not recognize that as the class doc unless I change the first line to

/*! class CLASSNAME

Is there a way to tell doxygen to use the "/**" style?

regards

php doxygen

share|improve this question

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Sort of off-topic; but if you're sick of PHPDocumentor - like I am - you might want to consider looking at DocBlox instead.
  
  – Berry Langerak
  Jun 6 '11 at 14:07
  
  

  
  
  
  

add a comment | 

1

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style:

/**
 * DESCRIPTION
 *
 * @category PHP
 * @package UserManagement.Class
 * @author Name <email@company.com>
 * @copyright 2011 Company
 * @link http://www.company.com
 */

but doxygen does not recognize that as the class doc unless I change the first line to

/*! class CLASSNAME

Is there a way to tell doxygen to use the "/**" style?

regards

php doxygen

share|improve this question

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Sort of off-topic; but if you're sick of PHPDocumentor - like I am - you might want to consider looking at DocBlox instead.
  
  – Berry Langerak
  Jun 6 '11 at 14:07
  
  

  
  
  
  

add a comment | 

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style:

/**
 * DESCRIPTION
 *
 * @category PHP
 * @package UserManagement.Class
 * @author Name <email@company.com>
 * @copyright 2011 Company
 * @link http://www.company.com
 */

but doxygen does not recognize that as the class doc unless I change the first line to

/*! class CLASSNAME

Is there a way to tell doxygen to use the "/**" style?

regards

php doxygen

share|improve this question

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

/**
 * DESCRIPTION
 *
 * @category PHP
 * @package UserManagement.Class
 * @author Name <email@company.com>
 * @copyright 2011 Company
 * @link http://www.company.com
 */

/*! class CLASSNAME

share|improve this question

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

share|improve this question

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

edited Jul 3 '14 at 6:40

Ikar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

asked Jun 6 '11 at 13:53

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

3 Answers
3

active

oldest

votes

2

I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.

share|improve this answer

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  if you are on PHP 5.3 you should be able to use namespacing to provide this functionality (a bit of a hack but will probably provide the functionality you need) of course depending on situation this may/may not be possible with what you have
  
  – JoshB
  Jun 27 '11 at 16:56
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  In fact if @category and/or @package are present the class detailed description can be found in the Namespaces section in generated documentation.
  
  – Ikar Pohorský
  Jul 3 '14 at 6:54
  

  
  
  
  

add a comment | 

2

Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.

To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to YES in your config file.

For more on how Doxygen documentation style have a look at this

share|improve this answer

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  JAVADOC_AUTOBRIEF is enabled and it does recognise them for functions but not for classes. So the "Detailed Description" of the documentation is empty.
  
  – ChrFin
  Jun 6 '11 at 15:55
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @chrfin what does it display then for classes?
  
  – JoshB
  Jun 6 '11 at 16:28
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Nothing: Detailed Description Definition at line 21 of file ...
  
  – ChrFin
  Jun 6 '11 at 18:18
  
  

  
  
  
  

add a comment | 

1

If for example your co-workers still use phpDoc you can use the INPUT_FILTER configuration to filter unwanted tags away:

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER = /home/gorgo/someproj/doc/doxygen.inputfilter

The inputfilter script must be executable and its content can be something like this:

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

share|improve this answer

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

add a comment | 

Your Answer

StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");

StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);

Sign up using Google

Sign up using Facebook

Sign up using Email and Password

Post as a guest

Name

Email

Required, but never shown

StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f6253064%2fhow-to-tell-doxygen-to-use-as-class-doc-instead-class%23new-answer', 'question_page');

);

Post as a guest

Name

Email

Required, but never shown

2

I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.

share|improve this answer

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  if you are on PHP 5.3 you should be able to use namespacing to provide this functionality (a bit of a hack but will probably provide the functionality you need) of course depending on situation this may/may not be possible with what you have
  
  – JoshB
  Jun 27 '11 at 16:56
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  In fact if @category and/or @package are present the class detailed description can be found in the Namespaces section in generated documentation.
  
  – Ikar Pohorský
  Jul 3 '14 at 6:54
  

  
  
  
  

add a comment | 

2

I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.

share|improve this answer

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  if you are on PHP 5.3 you should be able to use namespacing to provide this functionality (a bit of a hack but will probably provide the functionality you need) of course depending on situation this may/may not be possible with what you have
  
  – JoshB
  Jun 27 '11 at 16:56
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  In fact if @category and/or @package are present the class detailed description can be found in the Namespaces section in generated documentation.
  
  – Ikar Pohorský
  Jul 3 '14 at 6:54
  

  
  
  
  

add a comment | 

I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.

share|improve this answer

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

share|improve this answer

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

answered Jun 8 '11 at 17:36

ChrFinChrFin

18.2k99 gold badges5555 silver badges9292 bronze badges

2

Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.

To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to YES in your config file.

For more on how Doxygen documentation style have a look at this

share|improve this answer

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  JAVADOC_AUTOBRIEF is enabled and it does recognise them for functions but not for classes. So the "Detailed Description" of the documentation is empty.
  
  – ChrFin
  Jun 6 '11 at 15:55
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @chrfin what does it display then for classes?
  
  – JoshB
  Jun 6 '11 at 16:28
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Nothing: Detailed Description Definition at line 21 of file ...
  
  – ChrFin
  Jun 6 '11 at 18:18
  
  

  
  
  
  

add a comment | 

2

Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.

To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to YES in your config file.

For more on how Doxygen documentation style have a look at this

share|improve this answer

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  JAVADOC_AUTOBRIEF is enabled and it does recognise them for functions but not for classes. So the "Detailed Description" of the documentation is empty.
  
  – ChrFin
  Jun 6 '11 at 15:55
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @chrfin what does it display then for classes?
  
  – JoshB
  Jun 6 '11 at 16:28
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Nothing: Detailed Description Definition at line 21 of file ...
  
  – ChrFin
  Jun 6 '11 at 18:18
  
  

  
  
  
  

add a comment | 

Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.

To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to YES in your config file.

For more on how Doxygen documentation style have a look at this

share|improve this answer

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

share|improve this answer

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

edited Mar 25 at 18:08

albert

3,31733 gold badges1111 silver badges2525 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

answered Jun 6 '11 at 15:30

JoshBJoshB

50911 gold badge44 silver badges1111 bronze badges

1

If for example your co-workers still use phpDoc you can use the INPUT_FILTER configuration to filter unwanted tags away:

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER = /home/gorgo/someproj/doc/doxygen.inputfilter

The inputfilter script must be executable and its content can be something like this:

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

share|improve this answer

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

add a comment | 

1

If for example your co-workers still use phpDoc you can use the INPUT_FILTER configuration to filter unwanted tags away:

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER = /home/gorgo/someproj/doc/doxygen.inputfilter

The inputfilter script must be executable and its content can be something like this:

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

share|improve this answer

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

add a comment | 

If for example your co-workers still use phpDoc you can use the INPUT_FILTER configuration to filter unwanted tags away:

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER = /home/gorgo/someproj/doc/doxygen.inputfilter

The inputfilter script must be executable and its content can be something like this:

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

share|improve this answer

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER = /home/gorgo/someproj/doc/doxygen.inputfilter

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

share|improve this answer

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges

answered Jul 26 '13 at 8:57

Ikar PohorskýIkar Pohorský

1,48422 gold badges1515 silver badges3535 bronze badges