I will merge this. There are few things to be sorted out in short term:
- variables to be declared at the beginning of functions or blocks, to be sure it still compiles with old strict C compilers
- add license at the top of the c/h files - it must be GPLv2 or BSD, at your choice
We will grant you direct commit access to main kamailio repository, so you can push those updates directly.
---
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3#issuecomment-68607889
Hi!
While going through the core files, I noted that some of the history messages - typically the first line or two - has important information about the content of the file, which is not always copied into the Doxygen.
Each file should have a doxygen declaration, like:
/*!
* \file
* \brief Kamailio core :: <description of this file>
* \ingroup core
* Module: \ref core
*/
Please make sure that you preserve the file information. You can add a few lines of description that you find elsewhere
to the block, like:
/*!
* \file
* \brief Kamailio core :: Gnurging the smorifians
* The smorifians are dangerous parts of a SIP message and needs to be gnurged. This
* code file handles 94.25% of these cases. If you find out how to complete the process,
* please add new functions.
* \ingroup core
* Module: \ref core
*/
You may also add
* \author Gonzilla the IIIrd, emperor of GowarkiStania <gonzilla(a)gowarkistania.skrep>
To this section if you find an author or multiple ones.
Doxygen for Kamailio is generated here:
http://sip-router.org/doxygen/sip-router/branch/master/
I did also change any text saying "ser" or "sip-router" to "Kamailio" while I was in the file changing
text in comments.
Doxygen is cool and very helpful for new developers that wants to find their way
around Kamailio source code.
/Olle
For all of you that haven't dared digging into the source code of the TM module.
Beware - it's a dangerous place:
* ***************************************************
* * Jiri's Source Memorial *
* * *
* * Welcome, pilgrim ! This is the greatest place *
* * where dramatic changes happend. There are not *
* * many places with a history like this, as there *
* * are not so many people like Jiri, one of the *
* * ser's fathers, who brought everywhere the wind *
* * of change, the flood of clean-up. We all felt *
* * his fatherly eye watching over us day and night.*
* * *
* * Please, preserve this codework heritage, as *
* * it's unlikely for fresh, juicy pieces of code to *
* * arise to give him the again the chance to *
* * demonstrate his clean-up and improvement skills.*
* * *
* * Hereby, we solicit you to adopt this historical *
* * piece of code. For $100, your name will be *
* * be printed in this banner and we will use *
* * collected funds to create and display an ASCII *
* * statue of Jiri . *
* ***************************************************
/O :-)