ASTERISK-05357: [patch] Improve doxygen docs with README files and configuration files

[Home]

Summary: ASTERISK-05357: [patch] Improve doxygen docs with README files and configuration files

Reporter: Olle Johansson (oej) Labels:

Date Opened: 2005-10-24 04:33:15 Date Closed: 2008-01-15 15:52:07.000-0600

Priority: Minor Regression? No

Status: Closed/Complete Components: Documentation

Versions: Frequency of
Occurrence

Related
Issues:

Environment: Attachments: ( 0) asterisk-doxygen-header
( 1) asterisk-logo.gif
( 2) doxyconfig.txt
( 3) doxyfiles.txt
( 4) doxyref.h

Description: This is not complete, but ´moving forward. This patch changes the first page of the doxygen docs to include copyright and license information.
It also adds a lot of the README files and sample configuration files to the doxygen documentation.

* doxyref.h is in include/asterisk and is included in asterisk.c
* asterisk-logo.gif is placed in images
* asterisk-doxygen-header is placed in contrib

Comments: By: Leif Madsen (lmadsen) 2005-10-24 10:29:22

/*! \page page1 Asterisk Developer's Documentation - appendixes -- should read "appendices" in doxyref.h

+ * \brief Trivial application to control playback a sound file -- should read "Trivial application to control playback of a sound file" in doxyfiledesc.txt

Thats about all I found in terms of spelling errors and such.
By: Olle Johansson (oej) 2005-10-24 10:37:43

The first one was mine :-) It should really read "Appendixes" in Swenglish :-)
By: Olle Johansson (oej) 2005-10-24 10:45:24

Fixed spelling errors reported by Leif.
By: Olle Johansson (oej) 2005-10-24 11:23:56

Will rename sections and pages in doxyref.h on suggestion from Drumkilla.
By: Serge Vecher (serge-v) 2005-10-24 13:22:44

Here are some suggestions:
1) app_setcdruserfield.c:
"Applictions connected with CDR engine" -- "Applications". May I also
suggest the use of "related to" instead of "connected with"? Also in app_cdr
2) apps_sms.c
"... implimentation" -- "implementation"
3) chan_iax2.c
append "Protocol" to "... Inter-Asterisk eXchange "?
4) chan_skinny.c
"Implementation of the Skinny ..." - "Implementation of Cisco SCCP ("Skinny")"
5) app_dial.c
"... and send an URL ..." - "and send a URL"
6) app_lookupblacklist.c
"... to lookup the callerid ..." - "to lookup a CallerID"
7) app_lookupcidname.c
app_setcidname.c
app_setcidnum.c
"... to set callerid ..." - "to set a CallerID"
By: Olle Johansson (oej) 2005-10-24 14:36:44

Vechers: Thank you for feedback, but this time let's change formatting only in all the .c files... Otherwise, I'll never be done.
By: Olle Johansson (oej) 2005-10-24 15:38:55

Uploaded new version that covers more files.
By: Serge Vecher (serge-v) 2005-10-24 15:41:41

Misspelling of "FreeTDS" in "* \section cdrtds FeeTDS CDR driver configuration" -- doxyref.h
By: Russell Bryant (russell) 2005-10-24 15:51:21

I'm going to go ahead and work on merging all of this. However, I'm going to have to leave the image out for now, until we can ask about distributing that logo. I figure it will be easy enough to add it later.
By: Russell Bryant (russell) 2005-10-24 15:57:43

Veches, thanks for the catch. I will have that fix included.
By: Russell Bryant (russell) 2005-10-24 16:10:03

added to cvs head, but without the logo for now. Thanks!
By: Olle Johansson (oej) 2005-10-25 09:20:09

The config file patch is in "doxyconfig.txt" - seems to have gone missing.
By: Russell Bryant (russell) 2005-10-25 09:28:53

fixed :)
By: Digium Subversion (svnbot) 2008-01-15 15:52:05.000-0600

Repository: asterisk
Revision: 6847

U trunk/acl.c
U trunk/aescrypt.c
U trunk/aeskey.c
U trunk/alaw.c
U trunk/app.c
U trunk/apps/app_adsiprog.c
U trunk/apps/app_alarmreceiver.c
U trunk/apps/app_authenticate.c
U trunk/apps/app_cdr.c
U trunk/apps/app_chanisavail.c
U trunk/apps/app_chanspy.c
U trunk/apps/app_controlplayback.c
U trunk/apps/app_curl.c
U trunk/apps/app_cut.c
U trunk/apps/app_datetime.c
U trunk/apps/app_db.c
U trunk/apps/app_dial.c
U trunk/apps/app_dictate.c
U trunk/apps/app_directed_pickup.c
U trunk/apps/app_directory.c
U trunk/apps/app_disa.c
U trunk/apps/app_dumpchan.c
U trunk/apps/app_echo.c
U trunk/apps/app_enumlookup.c
U trunk/apps/app_eval.c
U trunk/apps/app_exec.c
U trunk/apps/app_externalivr.c
U trunk/apps/app_festival.c
U trunk/apps/app_flash.c
U trunk/apps/app_forkcdr.c
U trunk/apps/app_getcpeid.c
U trunk/apps/app_groupcount.c
U trunk/apps/app_hasnewvoicemail.c
U trunk/apps/app_ices.c
U trunk/apps/app_image.c
U trunk/apps/app_intercom.c
U trunk/apps/app_ivrdemo.c
U trunk/apps/app_lookupblacklist.c
U trunk/apps/app_lookupcidname.c
U trunk/apps/app_macro.c
U trunk/apps/app_math.c
U trunk/apps/app_md5.c
U trunk/apps/app_meetme.c
U trunk/apps/app_milliwatt.c
U trunk/apps/app_mixmonitor.c
U trunk/apps/app_mp3.c
U trunk/apps/app_muxmon.c
U trunk/apps/app_nbscat.c
U trunk/apps/app_osplookup.c
U trunk/apps/app_page.c
U trunk/apps/app_parkandannounce.c
U trunk/apps/app_playback.c
U trunk/apps/app_privacy.c
U trunk/apps/app_queue.c
U trunk/apps/app_random.c
U trunk/apps/app_read.c
U trunk/apps/app_readfile.c
U trunk/apps/app_realtime.c
U trunk/apps/app_record.c
U trunk/apps/app_rpt.c
U trunk/apps/app_sayunixtime.c
U trunk/apps/app_senddtmf.c
U trunk/apps/app_sendtext.c
U trunk/apps/app_setcallerid.c
U trunk/apps/app_setcdruserfield.c
U trunk/apps/app_setcidname.c
U trunk/apps/app_setcidnum.c
U trunk/apps/app_setrdnis.c
U trunk/apps/app_settransfercapability.c
U trunk/apps/app_skel.c
U trunk/apps/app_sms.c
U trunk/apps/app_softhangup.c
U trunk/apps/app_sql_postgres.c
U trunk/apps/app_striplsd.c
U trunk/apps/app_substring.c
U trunk/apps/app_system.c
U trunk/apps/app_talkdetect.c
U trunk/apps/app_test.c
U trunk/apps/app_transfer.c
U trunk/apps/app_txtcidname.c
U trunk/apps/app_url.c
U trunk/apps/app_userevent.c
U trunk/apps/app_verbose.c
U trunk/apps/app_voicemail.c
U trunk/apps/app_waitforring.c
U trunk/apps/app_waitforsilence.c
U trunk/apps/app_while.c
U trunk/apps/app_zapateller.c
U trunk/apps/app_zapbarge.c
U trunk/apps/app_zapras.c
U trunk/apps/app_zapscan.c
U trunk/asterisk.c
U trunk/astmm.c
U trunk/autoservice.c
U trunk/callerid.c
U trunk/cdr.c
U trunk/channel.c
U trunk/channels/chan_agent.c
U trunk/channels/chan_alsa.c
U trunk/channels/chan_features.c
U trunk/channels/chan_h323.c
U trunk/channels/chan_iax2.c
U trunk/channels/chan_local.c
U trunk/channels/chan_mgcp.c
U trunk/channels/chan_modem.c
U trunk/channels/chan_modem_i4l.c
U trunk/channels/chan_nbs.c
U trunk/channels/chan_oss.c
U trunk/channels/chan_phone.c
U trunk/channels/chan_sip.c
U trunk/channels/chan_skinny.c
U trunk/channels/chan_vpb.c
U trunk/channels/chan_zap.c
U trunk/chanvars.c
U trunk/cli.c
U trunk/config.c
A trunk/contrib/asterisk-doxygen-header
U trunk/db.c
U trunk/devicestate.c
U trunk/dns.c
U trunk/dnsmgr.c
U trunk/dsp.c
U trunk/enum.c
U trunk/file.c
U trunk/frame.c
U trunk/fskmodem.c
U trunk/funcs/func_callerid.c
U trunk/funcs/func_cdr.c
U trunk/funcs/func_db.c
U trunk/funcs/func_enum.c
U trunk/funcs/func_env.c
U trunk/funcs/func_groupcount.c
U trunk/funcs/func_language.c
U trunk/funcs/func_logic.c
U trunk/funcs/func_math.c
U trunk/funcs/func_md5.c
U trunk/funcs/func_moh.c
U trunk/funcs/func_strings.c
U trunk/funcs/func_timeout.c
U trunk/funcs/func_uri.c
U trunk/funcs/pbx_functions.c
U trunk/image.c
U trunk/include/asterisk/acl.h
U trunk/include/asterisk/adsi.h
U trunk/include/asterisk/aes.h
U trunk/include/asterisk/agi.h
U trunk/include/asterisk/alaw.h
U trunk/include/asterisk/app.h
U trunk/include/asterisk/astdb.h
U trunk/include/asterisk/astmm.h
U trunk/include/asterisk/astosp.h
U trunk/include/asterisk/callerid.h
U trunk/include/asterisk/causes.h
U trunk/include/asterisk/cdr.h
U trunk/include/asterisk/channel.h
U trunk/include/asterisk/chanvars.h
U trunk/include/asterisk/cli.h
U trunk/include/asterisk/compat.h
U trunk/include/asterisk/compiler.h
U trunk/include/asterisk/config.h
U trunk/include/asterisk/crypto.h
U trunk/include/asterisk/devicestate.h
U trunk/include/asterisk/dns.h
U trunk/include/asterisk/dnsmgr.h
A trunk/include/asterisk/doxyref.h
U trunk/include/asterisk/dsp.h
U trunk/include/asterisk/dundi.h
U trunk/include/asterisk/endian.h
U trunk/include/asterisk/enum.h
U trunk/include/asterisk/features.h
U trunk/include/asterisk/file.h
U trunk/include/asterisk/frame.h
U trunk/include/asterisk/fskmodem.h
U trunk/include/asterisk/image.h
U trunk/include/asterisk/indications.h
U trunk/include/asterisk/inline_api.h
U trunk/include/asterisk/io.h
U trunk/include/asterisk/localtime.h
U trunk/include/asterisk/lock.h
U trunk/include/asterisk/manager.h
U trunk/include/asterisk/md5.h
U trunk/include/asterisk/monitor.h
U trunk/include/asterisk/musiconhold.h
U trunk/include/asterisk/netsock.h
U trunk/include/asterisk/options.h
U trunk/include/asterisk/pbx.h
U trunk/include/asterisk/plc.h
U trunk/include/asterisk/privacy.h
U trunk/include/asterisk/res_odbc.h
U trunk/include/asterisk/rtp.h
U trunk/include/asterisk/say.h
U trunk/include/asterisk/sched.h
U trunk/include/asterisk/slinfactory.h
U trunk/include/asterisk/srv.h
U trunk/include/asterisk/strings.h
U trunk/include/asterisk/tdd.h
U trunk/include/asterisk/term.h
U trunk/include/asterisk/time.h
U trunk/include/asterisk/transcap.h
U trunk/include/asterisk/translate.h
U trunk/include/asterisk/ulaw.h
U trunk/include/asterisk/unaligned.h
U trunk/include/asterisk/utils.h
U trunk/include/asterisk/vmodem.h
U trunk/indications.c
U trunk/io.c
U trunk/jitterbuf.c
U trunk/loader.c
U trunk/logger.c
U trunk/manager.c
U trunk/md5.c
U trunk/muted.c
U trunk/netsock.c
U trunk/pbx/dundi-parser.c
U trunk/pbx/pbx_ael.c
U trunk/pbx/pbx_config.c
U trunk/pbx/pbx_dundi.c
U trunk/pbx/pbx_gtkconsole.c
U trunk/pbx/pbx_loopback.c
U trunk/pbx/pbx_realtime.c
U trunk/pbx/pbx_spool.c
U trunk/pbx.c
U trunk/plc.c
U trunk/privacy.c
U trunk/res/res_adsi.c
U trunk/res/res_agi.c
U trunk/res/res_config_odbc.c
U trunk/res/res_crypto.c
U trunk/res/res_features.c
U trunk/res/res_indications.c
U trunk/res/res_monitor.c
U trunk/res/res_musiconhold.c
U trunk/res/res_odbc.c
U trunk/res/res_osp.c
U trunk/rtp.c
U trunk/say.c
U trunk/sched.c
U trunk/slinfactory.c
U trunk/srv.c
U trunk/tdd.c
U trunk/term.c
U trunk/translate.c
U trunk/ulaw.c
U trunk/utils.c

------------------------------------------------------------------------
r6847 | russell | 2008-01-15 15:52:04 -0600 (Tue, 15 Jan 2008) | 2 lines

Doxygen documentation update from oej (issue ASTERISK-5357)

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=6847
By: Digium Subversion (svnbot) 2008-01-15 15:52:07.000-0600

Repository: asterisk
Revision: 6849

U trunk/contrib/asterisk-ng-doxygen

------------------------------------------------------------------------
r6849 | russell | 2008-01-15 15:52:06 -0600 (Tue, 15 Jan 2008) | 2 lines

merge changes to doxygen config (issue ASTERISK-5357)

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=6849