Skip to content

Commit

Permalink
Some minor documentation changes, v0.22.3
Browse files Browse the repository at this point in the history
  • Loading branch information
phorward committed May 15, 2018
1 parent c1c29ed commit 330440e
Show file tree
Hide file tree
Showing 11 changed files with 228 additions and 214 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This file is used to document any relevant changes done to libphorward.

Released on: April 17, 2018

- v0.22.3: Updated documentation, thanks to AGS
- v0.22.2: inline-symbols incorrectly implemented in pbnf
- v0.22.1: Build-system fixes (Windows only)
- v0.22.1: pgetline() function as POSIX compatiblity layer
Expand Down
2 changes: 1 addition & 1 deletion Version
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
echo "0.22.2"
echo "0.22.3"

# When changing version number, remove src/version.h to regenerate it!
20 changes: 10 additions & 10 deletions configure

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion configure.ac
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
AC_PREREQ([2.68])
AC_INIT([Phorward Toolkit], [0.22.2])
AC_INIT([Phorward Toolkit], [0.22.3])
AC_PREFIX_DEFAULT([/usr])

AC_CONFIG_SRCDIR([src/phorward.tpl.h])
Expand Down
390 changes: 199 additions & 191 deletions doc/phorward.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions doc/phorward.t2t
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The Phorward Libraries
libphorward 0.22.1
April 2018
libphorward 0.22.3
May 2018

%!preproc(xhtml): '@([a-zA-Z0-9_]+)((\(\))?)' '[\1\2 #fn_\1]'
%!preproc(xhtml): '%NEED:(\d+)' "''' <!-- NEED \1 -->"
Expand Down Expand Up @@ -30,7 +30,7 @@ The library is made up of several modules. These are:

- **any** provides a dynamical, extendible data structure and interface to store, convert and handle variables of different value types ("variant" data type),
- **base** provides tools for dynamic data structures and utility functions used throughout the library, including linked lists, hash-tables, stacks and arrays,
- **parse** defines tools to express grammars and provides a built-in LALR(1) parser generator and objects to handle abstract syntax trees, integrating perfectly with the tools from *regex* for lexical analysis,
- **parse** defines tools to express grammars and provides a built-in LALR(1) parser generator and objects to handle abstract syntax trees, integrating perfectly with the tools from //regex// for lexical analysis,
- **regex** provides tools for lexical analysis and regular expression processing,
- **string** is an extended string processing library,
- **vm** can be used to implement and run stack-based virtual machines and instruction sets aimed to work with the *any* data type.
Expand Down
8 changes: 5 additions & 3 deletions doc/ref.t2t
Original file line number Diff line number Diff line change
Expand Up @@ -341,8 +341,8 @@ pboolean p_ccl_compat( pccl* l, pccl* r )

**Usage:**

Checks if the character-classes //l// and //r// are in the same
character universe and compatible for operations.
Checks if the character-classes //l// and //r// are configured
to be in the same character universe and compatible for operations.
%FUNCTION:END
%NEED:15
%FUNCTION:BEGIN
Expand All @@ -362,7 +362,7 @@ Returns the number of characters within a character-class.

Returns the total number of characters the class is holding.
%FUNCTION:END
%NEED:15
%NEED:17
%FUNCTION:BEGIN
=== p_ccl_create ===[fn_p_ccl_create]

Expand All @@ -376,6 +376,8 @@ pccl* p_ccl_create( int min, int max, char* ccldef )

Constructor function to create a new character-class.

//min// and //max// can either be specified as -1, so the configured default
constants PCCL_MIN and PCCL_MAX will be used. The values can also be inverted.

Returns a pointer to the newly created character-class. This pointer should be
released with [p_ccl_free() #fn_p_ccl_free] when its existence is no longer required.
Expand Down
3 changes: 2 additions & 1 deletion src/Makefile.in

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions src/base/ccl.c
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ static int ccl_SORTFUNC( plist* list, plistel* el, plistel* er )

/** Constructor function to create a new character-class.
//min// and //max// can either be specified as -1, so the configured default
constants PCCL_MIN and PCCL_MAX will be used. The values can also be inverted.
Returns a pointer to the newly created character-class. This pointer should be
released with p_ccl_free() when its existence is no longer required.
Expand Down Expand Up @@ -64,8 +66,8 @@ pccl* p_ccl_create( int min, int max, char* ccldef )
RETURN( ccl );
}

/** Checks if the character-classes //l// and //r// are in the same
character universe and compatible for operations. */
/** Checks if the character-classes //l// and //r// are configured
to be in the same character universe and compatible for operations. */
pboolean p_ccl_compat( pccl* l, pccl* r )
{
if( !( l && r ) )
Expand Down
2 changes: 1 addition & 1 deletion src/phorward.h
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ typedef char pboolean;



#define LIBPHORWARD_VERSION "0.22.2"
#define LIBPHORWARD_VERSION "0.22.3"



Expand Down
2 changes: 1 addition & 1 deletion src/version.h
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#define LIBPHORWARD_VERSION "0.22.2"
#define LIBPHORWARD_VERSION "0.22.3"

0 comments on commit 330440e

Please sign in to comment.