ASTERISK-05457: [patch] What to do when on boring flights and trains... Doxygen updates.

[Home]

Summary: ASTERISK-05457: [patch] What to do when on boring flights and trains... Doxygen updates.

Reporter: Olle Johansson (oej) Labels:

Date Opened: 2005-11-04 12:41:22.000-0600 Date Closed: 2008-01-15 15:56:03.000-0600

Priority: Minor Regression? No

Status: Closed/Complete Components: Documentation

Versions: Frequency of
Occurrence

Related
Issues:

Environment: Attachments: ( 0) doxyapps.txt
( 1) doxycdr.txt
( 2) doxychannels.txt
( 3) doxycodecs.txt
( 4) doxyformats.txt
( 5) doxyinclude.txt
( 6) doxymain.txt
( 7) doxymake.txt
( 8) doxypbx.txt
( 9) doxy-pbxconfig.txt
(10) doxystdtime.txt

Description: Updates to doxygen documentation
* Add module groups
* Add some explanations of channel, frame and other generic development concepts.

It's not the full explanation, but a start that we can work on.

Comments: By: Olle Johansson (oej) 2005-11-04 13:00:26.000-0600

Changing the Makefile so that we get proper version numbers and dates in the doxygen file. Tips on this taken from the doxygen docs. Documentation is good, useful documentation is better :-)
By: Olle Johansson (oej) 2005-11-04 13:04:26.000-0600

To do:

* Check for DOT in path and set HAVE_DOT=yes if we have dot.

I turned on tree view in this version.
By: Russell Bryant (russell) 2005-11-06 09:51:35.000-0600

You snuck some code changes into doxymain.txt, in ast_callerid_merge. Sneaky!
By: Russell Bryant (russell) 2005-11-06 09:54:40.000-0600

In doxy-pbxconfig, What is the change to pbx_load_module about?
By: Russell Bryant (russell) 2005-11-06 09:58:16.000-0600

I'm also going to leave out doxymakefile until we can automatically check for dot.
By: Russell Bryant (russell) 2005-11-06 10:01:50.000-0600

You added an extra "*/" in stdtime/localtime.c that kept it from building, but I fixed it. :)
By: Russell Bryant (russell) 2005-11-06 10:04:44.000-0600

A stray "};" is in include/asterisk/callerid.h below ast_describe_caller_presentation that keeps it from building.
By: Russell Bryant (russell) 2005-11-06 10:15:44.000-0600

I have merged everything except for the three that I have marked as "Fail". Once they are ready, I'll merge those and close it out. Thanks!
By: Russell Bryant (russell) 2005-11-06 13:17:03.000-0600

What do you think about moving the new text describing how channels are used into a new header file, and including it in channel.h? That way, we can add more in depth information without getting in the way of the code too much.
By: Olle Johansson (oej) 2005-11-06 15:08:16.000-0600

I'll fix those and upload soon. Thank's for going through all this, I know it was a big patch.
By: Olle Johansson (oej) 2005-11-14 06:47:32.000-0600

Uploaded non-sneaky doxymain.txt and new doxy-pbxconfig.txt without weird declaration that belongs in another patch.
By: Olle Johansson (oej) 2005-11-14 07:21:57.000-0600

doxymake.txt uploaded - now checks for dot in /usr/local/bin and /usr/bin
By: Olle Johansson (oej) 2005-11-14 07:24:22.000-0600

To answer the question: I think the text should be in the way for now, until people have added to it and changed it and we're satisfied... Hiding the documentation so people don't bother is worse than having to scroll down to find the code... ;-)
By: Russell Bryant (russell) 2005-11-14 14:10:53.000-0600

added to cvs head, thanks!
By: Digium Subversion (svnbot) 2008-01-15 15:54:09.000-0600

Repository: asterisk
Revision: 6979

U trunk/ChangeLog
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_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_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/cdr/cdr_csv.c
U trunk/cdr/cdr_custom.c
U trunk/cdr/cdr_manager.c
U trunk/cdr/cdr_odbc.c
U trunk/cdr/cdr_pgsql.c
U trunk/cdr/cdr_sqlite.c
U trunk/cdr/cdr_tds.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_misdn.c
U trunk/channels/chan_misdn_config.c
U trunk/channels/chan_modem.c
U trunk/channels/chan_modem_aopen.c
U trunk/channels/chan_modem_bestdata.c
U trunk/channels/chan_modem_i4l.c
U trunk/channels/chan_nbs.c
U trunk/channels/chan_oss.c
U trunk/channels/chan_oss_old.c
U trunk/channels/chan_phone.c
U trunk/channels/chan_skinny.c
U trunk/channels/chan_vpb.c
U trunk/channels/chan_zap.c
U trunk/codecs/codec_a_mu.c
U trunk/codecs/codec_adpcm.c
U trunk/codecs/codec_alaw.c
U trunk/codecs/codec_g723_1.c
U trunk/codecs/codec_g726.c
U trunk/codecs/codec_gsm.c
U trunk/codecs/codec_ilbc.c
U trunk/codecs/codec_lpc10.c
U trunk/codecs/codec_speex.c
U trunk/codecs/codec_ulaw.c
U trunk/formats/format_au.c
U trunk/formats/format_g723.c
U trunk/formats/format_g726.c
U trunk/formats/format_g729.c
U trunk/formats/format_gsm.c
U trunk/formats/format_h263.c
U trunk/formats/format_ilbc.c
U trunk/formats/format_jpeg.c
U trunk/formats/format_ogg_vorbis.c
U trunk/formats/format_pcm.c
U trunk/formats/format_pcm_alaw.c
U trunk/formats/format_sln.c
U trunk/formats/format_vox.c
U trunk/formats/format_wav.c
U trunk/formats/format_wav_gsm.c
U trunk/include/asterisk/app.h
U trunk/include/asterisk/callerid.h
U trunk/include/asterisk/channel.h
U trunk/include/asterisk/doxyref.h
U trunk/include/asterisk/frame.h
U trunk/include/asterisk/fskmodem.h
U trunk/pbx/pbx_dundi.c
U trunk/stdtime/localtime.c
U trunk/stdtime/test.c
U trunk/stdtime/tzfile.h

------------------------------------------------------------------------
r6979 | russell | 2008-01-15 15:54:09 -0600 (Tue, 15 Jan 2008) | 2 lines

issue ASTERISK-5457

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

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

Repository: asterisk
Revision: 7096

U trunk/ChangeLog
U trunk/Makefile
U trunk/app.c
U trunk/asterisk.c
U trunk/callerid.c
U trunk/cdr.c
U trunk/contrib/asterisk-ng-doxygen
U trunk/frame.c
U trunk/fskmodem.c
U trunk/jitterbuf.c
U trunk/manager.c
U trunk/muted.c
U trunk/pbx/pbx_config.c
U trunk/pbx.c
U trunk/say.c
U trunk/translate.c
U trunk/ulaw.c

------------------------------------------------------------------------
r7096 | russell | 2008-01-15 15:56:02 -0600 (Tue, 15 Jan 2008) | 2 lines

finish merging doxygen updates from issue ASTERISK-5457

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

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