[mythtv] [patch] Doxygen doc update.

[Stuart Auchterlonie]

On Wed, Oct 12, 2005 at 03:52:31PM -0400, Daniel Kristjansson wrote:
> 
> BTW I'm always looking for doxygen documentation patches...
> 

Hah! Got one of those here!!!

Seems if the function spec in the comment doesn't match
the actual function spec then the documentation isn't
completely generated, only the basic skeleton.

This one's for dvbsignalmonitor


Stuart

---

-------------- next part --------------
Index: mythtv/libs/libmythtv/dvbsignalmonitor.cpp
===================================================================
--- mythtv.orig/libs/libmythtv/dvbsignalmonitor.cpp	2005-10-06 08:56:59.000000000 +0100
+++ mythtv/libs/libmythtv/dvbsignalmonitor.cpp	2005-10-06 08:57:20.000000000 +0100
@@ -26,7 +26,7 @@
 #define DBG_SM(FUNC, MSG) VERBOSE(VB_CHANNEL, \
     "DVBSM("<<channel->GetDevice()<<")::"<<FUNC<<": "<<MSG);
 
-/** \fn DVBSignalMonitor::DVBSignalMonitor(int,int,int)
+/** \fn DVBSignalMonitor::DVBSignalMonitor(int,DVBChannel*,uint,const char*)
  *  \brief Initializes signal lock and signal values.
  *
  *   Start() must be called to actually begin continuous
@@ -109,7 +109,7 @@
     return dynamic_cast<DVBChannel*>(channel)->GetCardNum();
 }
 
-/** \fn DVBSignalMonitor::Stop()
+/** \fn DVBSignalMonitor::Stop(void)
  *  \brief Stop signal monitoring and table monitoring threads.
  */
 void DVBSignalMonitor::Stop(void)