Skip to content

Commit

Permalink
Documentation, bug fixes and tweaks
Browse files Browse the repository at this point in the history
Bug fixes / tweaks:
- fixed typo in foreign-enum-value.
- defcenum: renamed argument, allow a docstring.
- defcvar and defcfun: also accept symbols as names.
- defcvar: added (declare (ignore value)) when read-only is true.
- foreign-funcall: fixed bug; premature canonicalization of the
  return-type. added regression test for this.
- defcfun and defcallback: use the make-gensym-list utility
- defcallback: return the callback name;
- strings.lisp: fixed the docstrings for the :string translators;
- mem-aref: fixed bug/typo in its setf-expander; added regression
  test for this.
- defcstruct and defcunion: allow a docstring.
- new tests: callbacks.qsort and funcall.string.3

Documentation:
- New file doc/Makefile for generating docs and uploading them to
  c-l.net.
- Added every cffi function/macro that is currently exported.
  documented half of them or so.
- colorize-lisp-examples.lisp: little script to colorize the examples
  in the texinfo-generated html docs.
- gendocs.sh: generate the docs in various formats as well as an
  index page from gendocs_template.
- further tweaks to doc/style.css.
  • Loading branch information
luismbo committed Aug 30, 2005
1 parent 8a3da94 commit 67fbc31
Show file tree
Hide file tree
Showing 15 changed files with 3,719 additions and 408 deletions.
40 changes: 40 additions & 0 deletions doc/Makefile
@@ -0,0 +1,40 @@
# -*- Mode: Makefile; tab-width: 3; indent-tabs-mode: t -*-
#
# Makefile --- Make targets for generating the documentation.
#
# Copyright (C) 2005, Luis Oliveira <loliveira at common-lisp.net>
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use, copy,
# modify, merge, publish, distribute, sublicense, and/or sell copies
# of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#

clean:
find . \( -name "*.info" -o -name "*.aux" -o -name "*.cp" -o -name "*.fn" -o -name "*.fns" -o -name "*.ky" -o -name "*.log" -o -name "*.pg" -o -name "*.toc" -o -name "*.tp" -o -name "*.vr" \) -exec rm {} \;
rm -rf manual spec

docs:
sh gendocs.sh -o manual --html "--css-include=style.css" cffi-manual "CFFI User Manual"
sh gendocs.sh -o spec --html "--css-include=style.css" cffi-sys-spec "CFFI-SYS Interface Specification"

upload-docs:
rsync -av --delete -e ssh manual spec common-lisp.net:/project/cffi/public_html/
# scp -r manual spec common-lisp.net:/project/cffi/public_html/

# vim: ft=make ts=3 noet

0 comments on commit 67fbc31

Please sign in to comment.