AkWebsoft

Technology Applications. Programming Language Documentation.

 phone
email
Documentation for my general programming language modules:
Click "here" on the top line of any section for module documentation
This documentation is a work in progress. More modules to come!
Overview:
The documentation that you will be linked to is generated by my documentation system. This system
works across all of the programming languages that I use, and does not depend on docstrings.
Indeed, rebol supports a very sophisticated docstring protocol, python uses simpler docstrings,
and newlisp allows unbound strings inside of functions. In contrast, Javascript does not support any
type of docstring that I know of.

Regardless of the language, I've never cared for having documentation inside of function code.

The system I use depends on two simple delimiters for the beginnings and endings of documentation
blocks, thus enabling automatic folding and unfolding for any type of sophisticated programmer's
editor or IDE. Leveraging this method, I can create documentation "trees" for any project.
What's more, it is very easy to add a new language or module.

The documentation contains a simple mark-up protocol that enables the doc application to substitute
HTML markup, but leaves the source code documentation readable.

Javascript: Click here for module documentation.

Javascript is the client-side programming language that is embedded in all major browsers.
It provides a more "computer-like" experience for the user because it has the ability
to access HTML documents as objects. This provides for fine-grained, dynamic control over the
content and behavior of a document.
Javascript enables a document to communicate with servers directly without refreshing the page.
This process is called AJAX. Example: If you click on my email address at the top of this page,
the result is an AJAX "call"

Rebol: Click here for module documentation.

Rebol is an extremely efficient and productive programming language. It has a small but very
talented user base. I have exensive modules developed over the last 10 years.
Rebol is a very good choice for smaller programming projects, although I have used it for larger
projects. Rebol is extremely easy to install, does not need any extensive system configuration
such as might be needed for python. Rebol is distributed with an extensive programming library
called the "Mezzanine" that is unpacked into memory during runtime.

Python: Click here for module documentation.

Python is the server-side programming language of choice for Google programmers. Python offers
a high degree of readability. It is well-engineered for Object-Oriented programming and is a very good
choice for team programming projects where more than one programmer is working on the same
code base. The language community offers a rich set of libraries for enhanced productivity.

Newlisp: Click here for module documentation.

Newlisp has a lisp-style syntax based on parenthesis. Like rebol and other lisps and schemes
and unlike python, newlisp makes use of symbols.
Like rebol, newlisp has a small footprint and is very easy to install. Unlike rebol, newlisp can
easily compiled into C and C++ programs to enable very efficient coding.
Newlisp is also provided as a DLL (on windows) or as a shared object on *nix platforms to enable
newlisp function calls from other languages. Newlisp is downloaded with a rich set of programming
tools, provides OOP functionality and has built in functional constructs.