doxygen.dox.in 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /**
  2. * @mainpage
  3. * Project Website: http://www.fsf.org/software/osip
  4. *
  5. * @verbinclude README
  6. *
  7. * @verbinclude HISTORY
  8. *
  9. * @verbinclude FEATURES
  10. *
  11. */
  12. /**
  13. * @defgroup libosip2 The GNU oSIP stack
  14. * @brief libosip2 Version @OSIP_VERSION@
  15. *
  16. * @see http://www.fsf.org/software/osip
  17. *
  18. * @section what_is_it What is oSIP
  19. *
  20. * libosip2 implements the Session Initiation Protocol (SIP -rfc3261-)
  21. * libosip2 is LGPL (COPYING). Please understand the licencing details
  22. * before using it!
  23. *
  24. * @section what_is_sip What is SIP
  25. *
  26. * SIP is an IP telephony protocol made by the IETF.
  27. * It is an effort to create a simple (telephony is never
  28. * simple) and powerfull protocol for next generation
  29. * telephony systems.
  30. *
  31. * @section what_features SIP features
  32. *
  33. * SIP is not just about telephony. It's much more
  34. * that what you expect from phones. SIP means mobility,
  35. * video, textual call informations, file exchange,
  36. * instant messaging, presence support and much more!
  37. *
  38. * @section what_freesoftware oSIP is free software
  39. *
  40. * As oSIP is LGPL, you still have the choice to implement
  41. * propriatory application and link with oSIP. For the
  42. * benefit of the community (and for your own benefit),
  43. * please consider implementing your application in GPL.
  44. *
  45. * @section what_thanks Thanks
  46. *
  47. * Thanks to all the contributors and to all bug reporters.
  48. * Enjoy osip!
  49. *
  50. */
  51. /**
  52. * @defgroup osip2_parser The parser modules
  53. * @brief Parser APIs.
  54. *
  55. * XXX
  56. */
  57. /**
  58. * @defgroup osip2_port The OS port modules
  59. * @brief Thread/Semaphore/Mutex APIs.
  60. *
  61. * XXX
  62. */
  63. /**
  64. * @defgroup osip2_fsm State Machines
  65. * @brief SIP transaction management APIs
  66. *
  67. * XXX
  68. */
  69. /**
  70. * @page osip2_readme README
  71. * @verbinclude README
  72. */
  73. /**
  74. * @page osip2_install INSTALL
  75. * @verbinclude INSTALL
  76. */
  77. /**
  78. * @page osip2_features FEATURES
  79. * @verbinclude FEATURES
  80. */
  81. /**
  82. * @page osip2_license COPYING
  83. * @verbinclude COPYING
  84. */
  85. /**
  86. * @page osip2_changelog ChangeLog
  87. * @verbinclude ChangeLog
  88. */