communications Log


Commit Date  
[e9066d] by Mike Miller Mike Miller

doc: strip trailing whitespace from package documentation

* INDEX, doc/comms.txi: Strip trailing whitespace.

2013-11-11 14:08:41 Tree
[ca2812] by Mike Miller Mike Miller

glu: fix typo in docstring

* gf.cc (Fglu): Add omitted newline and escape in the function docstring.

2013-11-11 04:29:18 Tree
[b075f7] by Mike Miller Mike Miller

doc: spellcheck docstrings and documentation

INDEX, doc/comms.txi, doc/commsimages.m, inst/@galois/convmtx.m,
inst/@galois/deconv.m, inst/@galois/fft.m, inst/@galois/ifft.m,
inst/@galois/roots.m, inst/ademodce.m, inst/amodce.m, inst/apkconst.m,
inst/awgn.m, inst/bchpoly.m, inst/biterr.m, inst/bsc.m, inst/comms.m,
inst/cosets.m, inst/demodmap.m, inst/dpcmdeco.m, inst/dpcmenco.m,
inst/dpcmopt.m, inst/egolayenc.m, inst/egolaygen.m, inst/encode.m,
inst/eyediagram.m, inst/fibodeco.m, inst/fiboenco.m, inst/fibosplitstream.m,
inst/gen2par.m, inst/genqammod.m, inst/gftable.m, inst/golombdeco.m,
inst/golombenco.m, inst/huffmandeco.m, inst/huffmanenco.m, inst/lloyds.m,
inst/matdeintrlv.m, inst/matintrlv.m, inst/minpol.m, inst/modmap.m,
inst/qaskdeco.m, inst/qaskenco.m, inst/quantiz.m, inst/randint.m,
inst/randsrc.m, inst/reedmullerdec.m, inst/reedmullerenc.m,
inst/reedmullergen.m, inst/ricedeco.m, inst/riceenco.m, inst/rleenco.m,
inst/rsdecof.m, inst/rsencof.m, inst/rsgenpoly.m, inst/scatterplot.m,
inst/shannonfanodeco.m, inst/shannonfanodict.m, inst/shannonfanoenco.m,
inst/symerr.m, inst/systematize.m, inst/wgn.m, src/cyclpoly.cc, src/gf.cc:
Fix spelling errors, capitalization errors, repeated words, and spacing
errors in all docstrings and package documentation.

2013-11-11 04:25:37 Tree
[fe27fc] by Mike Miller Mike Miller

doc: use @code instead of @dfn for references to functions

* inst/apkconst.m, inst/bchpoly.m, inst/compand.m, inst/de2bi.m,
inst/decode.m, inst/demodmap.m, inst/encode.m, inst/modmap.m, inst/qaskdeco.m,
inst/qaskenco.m, src/__errcore__.cc, src/__gfweight__.cc, src/cyclgen.cc,
src/gf.cc: Use @code instead of @dfn for references to function names in
docstrings.

2013-11-11 02:37:28 Tree
[b678b3] by Mike Miller Mike Miller

maint: normalize GPL license headers

* doc/commsimages.m, inst/dpcmdeco.m, inst/dpcmenco.m, inst/dpcmopt.m,
src/cyclpoly.cc, src/galois-def.cc, src/galois.h, src/isprimitive.cc,
src/syndtable.cc: Reformat GPL license file headers to be consistent with
all other source files.

2013-11-11 02:14:45 Tree
[4c9317] by Mike Miller Mike Miller

doc: use Octave coding style for examples and embedded code strings

* inst/@galois/convmtx.m, inst/@galois/dftmtx.m, inst/@galois/diag.m,
inst/@galois/lu.m, inst/@galois/reshape.m, inst/decode.m, inst/dpcmdeco.m,
inst/dpcmenco.m, inst/dpcmopt.m, inst/egolaydec.m, inst/egolayenc.m,
inst/encode.m, inst/fibodeco.m, inst/fiboenco.m, inst/fibosplitstream.m,
inst/genqammod.m, inst/golombdeco.m, inst/golombenco.m, inst/huffmandeco.m,
inst/huffmandict.m, inst/huffmanenco.m, inst/modmap.m, inst/pamdemod.m,
inst/pammod.m, inst/prbs_generator.m, inst/prbs_iterator.m,
inst/prbs_sequence.m, inst/pskdemod.m, inst/pskmod.m, inst/qaskdeco.m,
inst/qaskenco.m, inst/quantiz.m, inst/reedmullerdec.m, inst/reedmullerenc.m,
inst/reedmullergen.m, inst/ricedeco.m, inst/riceenco.m, inst/rledeco.m,
inst/rleenco.m, inst/shannonfanodeco.m, inst/shannonfanodict.m,
inst/shannonfanoenco.m, inst/systematize.m, src/gf.cc: Use Octave coding
style for example blocks and embedded code strings. Format results properly
when given.

2013-11-11 01:51:25 Tree
[2e6403] by Mike Miller Mike Miller

doc: add missing space in pskdemod docstring

* inst/pskdemod.m: Add missing leading space in docstring.

2013-11-10 20:39:02 Tree
[662ab0] by Mike Miller Mike Miller

doc: add @group around multiline equations in docstrings

* inst/@galois/filter.m, inst/compand.m, src/gf.cc: Use @group/@end group
around multiline equations in function docstrings.

2013-11-10 20:38:07 Tree
[8e6adf] by Mike Miller Mike Miller

build: preserve leading whitespace in m-file docstrings

* mkdoc.pl (extract_description): Preserve leading whitespace in m-file
docstrings, only remove leading comment characters and a single space.

2013-11-10 20:36:19 Tree
[234a18] by Mike Miller Mike Miller

build: fix HTML build rule to update the directory timestamp

* Makefile (%.html): Fix the build rule to correctly update the timestamp
of the html directory.

2013-11-10 19:39:28 Tree
[508a9a] by Mike Miller Mike Miller

doc: correctly render images and equations in HTML format

* doc/comms.txi, inst/@galois/filter.m, inst/@galois/roots.m, inst/compand.m,
inst/rsgenpoly.m, src/cyclgen.cc, src/gf.cc: Use @ifnotinfo and @ifnottex to
properly select display of images and equations in all doc formats.

2013-11-10 19:27:56 Tree
[2fbeb4] by Mike Miller Mike Miller

doc: fix top-level node for HTML doc format

* comms.txi: Use @ifnottex for Top node to include it in the HTML doc
format.

2013-11-10 18:40:31 Tree
[d134cc] by Mike Miller Mike Miller

build: build PDF and DVI doc formats serially

* Makefile: build PDF and DVI doc formats serially to avoid a race
condition with intermediate temporary files. Based on Octave changeset
df3939195fbb.

2013-11-10 18:19:00 Tree
[92a95d] by Mike Miller Mike Miller

build: make HTML manual correctly

* Makefile (%.html): Simplify build rule. (HTMLDIR_IMAGES): New parameterized
target to copy PNG images into the HTML directory, borrowed from Octave.
(html): Depend on $(HTMLDIR_IMAGES).

2013-11-10 16:58:51 Tree
[7ba3b1] by Mike Miller Mike Miller

build: add GNU standard targets for documentation formats

* Makefile (dvi, html, info, pdf, ps): New targets. Delete unused targets.
Mark phony targets properly as .PHONY.

2013-11-10 16:41:44 Tree
[656d9a] by Mike Miller Mike Miller

build: make manual in PostScript format

* Makefile (all): Add $(INFODOC) and $(PSDOC). Do not copy info manual to
scripts directory.

2013-11-10 00:02:03 Tree
[e2ee3c] by Mike Miller Mike Miller

.hgignore: Ignore built doc formats and generated make file snippets.

* .hgignore: Ignore built doc formats and generated make file snippets.

2013-11-09 23:51:30 Tree
[970e31] by Mike Miller Mike Miller

build: add maintainer-clean make target for doc directory

* Makefile (maintainer-clean): Delete all generated documentation formats
and image files. (clean): Only delete intermediate files.

2013-11-09 23:48:13 Tree
[ded545] by Mike Miller Mike Miller

build: add rules to generate images for the manual

* commsimages.m: New function to generate images for the manual.
* images.sh: Script to generate make rules to build images using Octave.
* Makefile: Include images.mk and add dependencies so images are built
when needed.

2013-11-09 23:28:10 Tree
[e1c5c7] by Mike Miller Mike Miller

build: simplify build rules for the manual

* Makefile: Simplify build rules for the dvi, info, pdf, and ps targets.

2013-11-09 22:49:59 Tree
[2aaecf] by Mike Miller Mike Miller

build: import scripts needed to build the manual

* mkdoc.pl, mktexi.pl: Import scripts from Octave Forge admin directory.
* Makefile: Use them. Do not attempt to include configuration and scripts
from a parent directory.

2013-11-09 22:21:29 Tree
[50c005] by Mike Miller Mike Miller

doc: use @code instead of Octave-custom @qcode

* src/cyclpoly.cc, src/gf.cc, src/primpoly.cc: Use @code instead of @qcode
in docstrings.

2013-11-09 22:07:34 Tree
[712a82] by Mike Miller Mike Miller

doc: Use @dots for ellipses in docstrings

* inst/ademodce.m, inst/amodce.m, inst/apkconst.m, inst/awgn.m, inst/bchpoly.m,
inst/biterr.m, inst/decode.m, inst/demodmap.m, inst/encode.m,
inst/eyediagram.m, inst/hammgen.m, inst/lloyds.m, inst/modmap.m,
inst/qaskdeco.m, inst/qaskenco.m, inst/quantiz.m, inst/rsencof.m,
inst/rsgenpoly.m, inst/scatterplot.m, inst/symerr.m, inst/wgn.m: Use @dots for
ellipses in docstrings.

2013-11-09 21:15:54 Tree
[f13aec] by Mike Miller Mike Miller

maint: remove unnecessary array notation for single return values

* inst/amdemod.m, inst/ammod.m, inst/bsc.m, inst/fmmod.m, inst/qfunc.m,
inst/qfuncinv.m: Remove unnecessary array notation for single return values.

2013-11-09 21:01:02 Tree
[c4378d] by Mike Miller Mike Miller

doc: fix docstring spacing and word wrapping

* inst/@galois/det.m, inst/@galois/dftmtx.m, inst/@galois/filter.m,
inst/@galois/inv.m, inst/@galois/inverse.m, inst/@galois/rank.m,
inst/ademodce.m, inst/ammod.m, inst/amodce.m, inst/apkconst.m, inst/awgn.m,
inst/bchpoly.m, inst/bi2de.m, inst/biterr.m, inst/comms.m, inst/compand.m,
inst/cosets.m, inst/de2bi.m, inst/decode.m, inst/demodmap.m, inst/dpcmenco.m,
inst/dpcmopt.m, inst/egolaygen.m, inst/encode.m, inst/eyediagram.m,
inst/fibodeco.m, inst/fibosplitstream.m, inst/fmdemod.m, inst/fmmod.m,
inst/gen2par.m, inst/genqamdemod.m, inst/gfweight.m, inst/hammgen.m,
inst/helintrlv.m, inst/helscandeintrlv.m, inst/helscanintrlv.m,
inst/huffmandict.m, inst/lloyds.m, inst/modmap.m, inst/oct2dec.m,
inst/pamdemod.m, inst/pammod.m, inst/pskdemod.m, inst/pskmod.m,
inst/qamdemod.m, inst/qammod.m, inst/qaskdeco.m, inst/qaskenco.m,
inst/quantiz.m, inst/randerr.m, inst/randint.m, inst/randsrc.m,
inst/reedmullerdec.m, inst/reedmullerenc.m, inst/reedmullergen.m,
inst/rledeco.m, inst/rleenco.m, inst/rsdecof.m, inst/rsencof.m,
inst/rsgenpoly.m, inst/scatterplot.m, inst/shannonfanodeco.m,
inst/shannonfanodict.m, inst/shannonfanoenco.m, inst/symerr.m,
inst/systematize.m, inst/vec2mat.m, inst/wgn.m, src/gf.cc: fix docstring
spacing and word wrapping.

2013-11-09 22:51:23 Tree
Older >