[mythtv-commits] Ticket #2511: Doxygen \fn declarations don't match code

[MythTV]

#2511: Doxygen \fn declarations don't match code
--------------------+-------------------------------------------------------
 Reporter:  nigel   |        Owner:  nigel   
     Type:  task    |       Status:  assigned
 Priority:  minor   |    Milestone:  unknown 
Component:  mythtv  |      Version:  head    
 Severity:  medium  |   Resolution:          
--------------------+-------------------------------------------------------
Changes (by nigel):

  * owner:  ijr => nigel
  * status:  new => assigned

Comment:

 I have done most of the necessary changes in [11172], [11229], [11237] and
 [11241].
 [[BR]]
 I am ''not'' proposing to remove the \fn comments from every file. While
 it would be nice to have consistancy, keeping the \fn line seems tidier in
 multi-line comment blocks (when the params and return values are
 documented), and there are some examples where the comments are not beside
 the functions (libmythtv/diseqc.cpp from line 856 onwards).
 [[BR]]
 Plus, generally: if it isn't broken, don't change it.

-- 
Ticket URL: <http://cvs.mythtv.org/trac/ticket/2511#comment:1>
MythTV <http://www.mythtv.org/>
MythTV