project-navigation
Personal tools

Author Topic: [doxygen] strange warning  (Read 3693 times)

Offline Duke

  • Administrator
  • PHALANX veteran
  • *****
  • Posts: 1037
    • View Profile
[doxygen] strange warning
« on: March 01, 2014, 06:08:32 am »
Among other warnings, doxygen will produce the following warning message:
/src/shared/sharedptr.h:93: warning: end of comment block while expecting command </b>

Staring at sharedptr.h up and down didn't give me a clue what doxygen doesn't like here.

Warnings log eg. : http://ninex.info:8010/builders/doxygen/builds/886/steps/compile/logs/warnings%20%2873%29
sharedptr.h source: https://github.com/ufoai/ufoai/blob/master/src/shared/sharedptr.h

Offline Sandro

  • Squad Leader
  • ****
  • Posts: 239
  • Maintenance guy for UFO:AI 3D engine
    • View Profile
Re: [doxygen] strange warning
« Reply #1 on: March 01, 2014, 12:34:41 pm »
Block starts with the /** instead of /*

It therefore expects some doxygen, but can't find any.

Offline Duke

  • Administrator
  • PHALANX veteran
  • *****
  • Posts: 1037
    • View Profile
Re: [doxygen] strange warning
« Reply #2 on: March 01, 2014, 02:43:13 pm »
Can't believe that, butI'll try.
The line number fits, but we have tons of other comments with /** and no doxy inside.

Offline DarkRain

  • Project Coder
  • Captain
  • ***
  • Posts: 746
    • View Profile
Re: [doxygen] strange warning
« Reply #3 on: March 02, 2014, 12:09:50 am »
Line 88:
Code: [Select]
* assignment of a SharedPtr<B> object to a SharedPtr<A> object.Doxygen is obviously interpreting <B> as an opening tag and expects a closing one somewhere later...

Offline Duke

  • Administrator
  • PHALANX veteran
  • *****
  • Posts: 1037
    • View Profile
Re: [doxygen] strange warning
« Reply #4 on: March 03, 2014, 07:28:42 am »
Removing the 2nd asterisk solved the problem, probably because doxygen now skips the whole block of comment.

I now re-added the 2nd asterisk and just quoted the "SharedPtr<B>" and A.

Offline Duke

  • Administrator
  • PHALANX veteran
  • *****
  • Posts: 1037
    • View Profile
Re: [doxygen] strange warning
« Reply #5 on: March 04, 2014, 04:56:23 am »
Quoting the offending <B> also did the trick. So Sandro, your theory is busted.

Darkrain, while we're at it: Do you have a prudent description for the 'now' param of Delay_Events() ?
I know it's usually the system time in millisecs, but not always ...

Offline DarkRain

  • Project Coder
  • Captain
  • ***
  • Posts: 746
    • View Profile
Re: [doxygen] strange warning
« Reply #6 on: March 04, 2014, 06:52:19 pm »
Darkrain, while we're at it: Do you have a prudent description for the 'now' param of Delay_Events() ?
I know it's usually the system time in millisecs, but not always ...

"The current time"

Well, it is supposed to be the current time (but unittest just use arbitrary values, of course), during normal execution it is the time passed to Dequeue_Event() to check if events are due, then Dequeue_Event() passes it to a few functions, like Delay_Events() (most of which do absolutely nothing with it BTW)