From 7675e32896031e9b02e9cb9c0774147544b9dc6c Mon Sep 17 00:00:00 2001
From: yanmorin <yanmorin>
Date: Sun, 9 Apr 2006 22:44:09 +0000
Subject: [PATCH] Documentation generation (remove copyright as doxygen brief
 summary) doygen Doxyfile

---
 Doxyfile                      |  2 +-
 src/account.h                 | 10 +++++-----
 src/accountcreator.h          |  6 +++---
 src/audio/alaw.h              |  7 +++++--
 src/audio/dtmf.h              |  7 +++++--
 src/audio/gsmcodec.h          |  7 +++++--
 src/audio/tone.h              |  5 +++--
 src/audio/tonegenerator.h     | 10 +++++-----
 src/audio/ulaw.h              |  7 +++++--
 src/call.h                    |  7 +++----
 src/config/config.cpp         |  2 +-
 src/config/config.h           |  7 +++++--
 src/gui/server/ObjectPool.hpp |  5 ++++-
 src/iaxaccount.h              |  6 +++---
 src/iaxvoiplink.h             |  8 ++++----
 src/managerimpl.h             |  5 ++++-
 src/observer.cpp              |  4 ++--
 src/observer.h                |  7 +++++--
 src/sipaccount.h              |  4 ++--
 src/sipcall.h                 |  6 +++---
 src/sipvoiplink.h             |  5 +++--
 src/voIPLink.h                |  3 +++
 22 files changed, 79 insertions(+), 51 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index cf70b8dea6..6b4470767c 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -17,7 +17,7 @@
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = "SFLphone Deamon"
+PROJECT_NAME           = "SFLphone"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
 # This could be handy for archiving the generated documentation or 
diff --git a/src/account.h b/src/account.h
index a2ab5f6932..40586b5093 100644
--- a/src/account.h
+++ b/src/account.h
@@ -32,11 +32,11 @@ typedef std::string AccountID;
 
 
 /**
-	@author Yan Morin 
-  Class account is an interface to protocol account (sipaccount, aixaccount)
-  It can be enable on loading or activate after.
-  It contains account, configuration, VoIP Link and Calls (inside the VoIPLink)
-*/
+ * Class account is an interface to protocol account (sipaccount, aixaccount)
+ * It can be enable on loading or activate after.
+ * It contains account, configuration, VoIP Link and Calls (inside the VoIPLink)
+ * @author Yan Morin 
+ */
 class Account{
 public:
     Account(const AccountID& accountID);
diff --git a/src/accountcreator.h b/src/accountcreator.h
index cb156358b1..0023c4e388 100644
--- a/src/accountcreator.h
+++ b/src/accountcreator.h
@@ -24,9 +24,9 @@
 class Account;
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  AccountCreator create Protocol-specific Account
-*/
+ * AccountCreator create Protocol-specific Account
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class AccountCreator{
 public:
     ~AccountCreator();
diff --git a/src/audio/alaw.h b/src/audio/alaw.h
index c418a88772..3ebad55604 100644
--- a/src/audio/alaw.h
+++ b/src/audio/alaw.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc.
  *  Author:  Yan Morin <yan.morin@savoirfairelinux.com>
  *  Author:  Laurielle Lea <laurielle.lea@savoirfairelinux.com>
  *                                                                              
@@ -23,6 +23,9 @@
 
 #include "audiocodec.h"
 
+/**
+ * Alaw audio codec (payload is 8)
+ */
 class Alaw : public AudioCodec {
 public:
   // payload should be 8
diff --git a/src/audio/dtmf.h b/src/audio/dtmf.h
index 183d2fe14c..ef20ba74c0 100644
--- a/src/audio/dtmf.h
+++ b/src/audio/dtmf.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc.
  *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> 
  *
  * 	Portions Copyright (c) 2000 Billy Biggs <bbiggs@div8.net>
@@ -26,6 +26,9 @@
 #include "../global.h"
 #include "dtmfgenerator.h"
 
+/**
+ * DMTF library to generate a dtmf sample
+ */
 class DTMF {
 public:
   /**
diff --git a/src/audio/gsmcodec.h b/src/audio/gsmcodec.h
index 9f21aca8c7..d531e6e4f3 100644
--- a/src/audio/gsmcodec.h
+++ b/src/audio/gsmcodec.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *  Author:  Laurielle Lea <laurielle.lea@savoirfairelinux.com>
  *
@@ -26,6 +26,9 @@ extern "C" {
 #include "gsm/gsm.h"
 }
 
+/**
+ * GSM audio codec C++ class (over gsm/gsm.h)
+ */
 class Gsm : public AudioCodec {
 public:
   // _payload should be 3
diff --git a/src/audio/tone.h b/src/audio/tone.h
index 42d0dfe833..0604bd300b 100644
--- a/src/audio/tone.h
+++ b/src/audio/tone.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *
  *  Inspired by tonegenerator of 
@@ -29,6 +29,7 @@
 #define TONE_NBCOUNTRY 7
 
 /**
+ * Tone sample (dial, busy, ring, congestion)
  * @author Yan Morin <yan.morin@savoirfairelinux.com>
  */
 class Tone : public AudioLoop {
diff --git a/src/audio/tonegenerator.h b/src/audio/tonegenerator.h
index 968c5946b4..9a3bcdeba2 100644
--- a/src/audio/tonegenerator.h
+++ b/src/audio/tonegenerator.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2004-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
  *                                                                              
@@ -26,9 +26,9 @@
 
 #include "../global.h"
 
-///////////////////////////////////////////////////////////////////////////////
-// ToneGenerator
-///////////////////////////////////////////////////////////////////////////////
+/**
+ * Sine generator to create tone with string definition
+ */
 class ToneGenerator {
 public:
 	ToneGenerator (unsigned int sampleRate);
diff --git a/src/audio/ulaw.h b/src/audio/ulaw.h
index a515d9bfad..3ec369f691 100644
--- a/src/audio/ulaw.h
+++ b/src/audio/ulaw.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *  Author:  Laurielle Lea <laurielle.lea@savoirfairelinux.com>
  *                                                                              
@@ -23,6 +23,9 @@
 
 #include "audiocodec.h"
 
+/**
+ * Ulaw audio codec (payload = 0)
+ */
 class Ulaw : public AudioCodec {
 public:
   // payload should be 0
diff --git a/src/call.h b/src/call.h
index 1f260825e7..bd8bdc39c8 100644
--- a/src/call.h
+++ b/src/call.h
@@ -23,13 +23,12 @@
 #include <string>
 #include <cc++/thread.h> // for mutex
 
-//TODO: remove this, it's only for call ID
 typedef std::string CallID;
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  A call is the base classes for protocol-based calls
-*/
+ * A call is the base classes for protocol-based calls
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class Call{
 public:
     enum CallType {Incoming, Outgoing};
diff --git a/src/config/config.cpp b/src/config/config.cpp
index 6e0018e57b..76aa490fc9 100644
--- a/src/config/config.cpp
+++ b/src/config/config.cpp
@@ -1,4 +1,4 @@
-/**
+/*
  *  Copyright (C) 2005 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *
diff --git a/src/config/config.h b/src/config/config.h
index b09e309439..9171470c08 100644
--- a/src/config/config.h
+++ b/src/config/config.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -24,6 +24,9 @@
 #include <string>
 #include <list>
 
+/**
+ * Configuration namespace for ConfigTree object (like .ini files)
+ */
 namespace Conf {
 
 class ConfigTreeItem;
diff --git a/src/gui/server/ObjectPool.hpp b/src/gui/server/ObjectPool.hpp
index fa1f19af9a..f9c25bad57 100644
--- a/src/gui/server/ObjectPool.hpp
+++ b/src/gui/server/ObjectPool.hpp
@@ -1,4 +1,4 @@
-/**
+/*
  *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com> (cc++ mutex)
  *  Author: Jean-Philippe Barrette-LaPierre
@@ -26,6 +26,9 @@
 #include <string>
 #include <cc++/thread.h>
 
+/**
+ * Pool Interface (multithread)
+ */
 template< typename T >
 class ObjectPool
 {
diff --git a/src/iaxaccount.h b/src/iaxaccount.h
index 3780d166d9..4b79f9860c 100644
--- a/src/iaxaccount.h
+++ b/src/iaxaccount.h
@@ -22,9 +22,9 @@
 #include "account.h"
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  An IAX Account specify IAX specific functions and objects (IAXCall/IAXVoIPLink)
-*/
+ * An IAX Account specify IAX specific functions and objects (IAXCall/IAXVoIPLink)
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class IAXAccount : public Account
 {
 public:
diff --git a/src/iaxvoiplink.h b/src/iaxvoiplink.h
index 56f9755cfd..9f29e97567 100644
--- a/src/iaxvoiplink.h
+++ b/src/iaxvoiplink.h
@@ -25,10 +25,10 @@
 class AudioCodec;
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  VoIPLink contains a thread that listen to external events and 
-  contains IAX Call related functions
-*/
+ * VoIPLink contains a thread that listen to external events 
+ * and contains IAX Call related functions
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class IAXVoIPLink : public VoIPLink
 {
 public:
diff --git a/src/managerimpl.h b/src/managerimpl.h
index 90f379499c..e12c51908e 100644
--- a/src/managerimpl.h
+++ b/src/managerimpl.h
@@ -82,12 +82,15 @@ typedef std::set<CallID> CallIDSet;
  */
 typedef std::list<std::string> TokenList;
 
+/**
+ * Manager (controller) of sflphone daemon
+ */
 class ManagerImpl {
 public:
   ManagerImpl (void);
   ~ManagerImpl (void);
 
-	// Init a new VoIPLink, audio codec and audio driver
+  // Init a new VoIPLink, audio codec and audio driver
   /**
    * Initialisation of thread (sound) and map
    */
diff --git a/src/observer.cpp b/src/observer.cpp
index 022c3316a5..d7343b3aaa 100644
--- a/src/observer.cpp
+++ b/src/observer.cpp
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *
  *  This program is free software; you can redistribute it and/or modify
diff --git a/src/observer.h b/src/observer.h
index 785cba8741..71b44d339c 100644
--- a/src/observer.h
+++ b/src/observer.h
@@ -1,5 +1,5 @@
-/**
- *  Copyright (C) 2005 Savoir-Faire Linux inc.
+/*
+ *  Copyright (C) 2005-2006 Savoir-Faire Linux inc.
  *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
  *
  *  This program is free software; you can redistribute it and/or modify
@@ -27,6 +27,9 @@
  */
 namespace Pattern {
 
+/**
+ * Observer interface
+ */
 class Observer {
 public:
   virtual ~Observer() {};
diff --git a/src/sipaccount.h b/src/sipaccount.h
index c5da7b18fe..e2bf11e66e 100644
--- a/src/sipaccount.h
+++ b/src/sipaccount.h
@@ -22,8 +22,8 @@
 #include "account.h"
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  A Sip Account specify SIP specific functions and object (SIPCall/SIPVoIPLink)
+ * A Sip Account specify SIP specific functions and object (SIPCall/SIPVoIPLink)
+ * @author Yan Morin <yan.morin@gmail.com>
 */
 class SIPAccount : public Account
 {
diff --git a/src/sipcall.h b/src/sipcall.h
index cbe640a055..1bd9413515 100644
--- a/src/sipcall.h
+++ b/src/sipcall.h
@@ -27,9 +27,9 @@
 class AudioCodec;
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-  SIPCall are SIP implementation of a normal Call 
-*/
+ * SIPCall are SIP implementation of a normal Call 
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class SIPCall : public Call
 {
 public:
diff --git a/src/sipvoiplink.h b/src/sipvoiplink.h
index 4c67fee05c..65ebc4010d 100644
--- a/src/sipvoiplink.h
+++ b/src/sipvoiplink.h
@@ -29,8 +29,9 @@ class EventThread;
 class SIPCall;
 
 /**
-	@author Yan Morin <yan.morin@gmail.com>
-*/
+ * Specific VoIPLink for SIP (SIP core for incoming and outcoming events)
+ * @author Yan Morin <yan.morin@gmail.com>
+ */
 class SIPVoIPLink : public VoIPLink
 {
 public:
diff --git a/src/voIPLink.h b/src/voIPLink.h
index e0644bb220..9f74bdbeb0 100644
--- a/src/voIPLink.h
+++ b/src/voIPLink.h
@@ -31,6 +31,9 @@ class AudioCodec;
 
 typedef std::map<CallID, Call*> CallMap;
 
+/**
+ * Listener and manager interface for each VoIP protocol
+ */
 class VoIPLink {
 public:
 	VoIPLink(const AccountID& accountID);
-- 
GitLab