diff --git a/contrib/cmake/README b/contrib/cmake/README index 09343b13f..fae4a15af 100644 --- a/contrib/cmake/README +++ b/contrib/cmake/README @@ -1,36 +1,36 @@ -CMAKE Files contributed by Andrew J. P. Maclean - - -Put the following files in the directory where your source code is: - CMakeLists.txt - PocoConfig.cmake. - -Edit CMakeLists.txt to include your source and header files. The sections of interest are: -# Add any source files here. -SET( EXE_SRCS - "My File.cpp" -) -# Add any include files here. -SET( EXE_INCS - "My File.h" -) - -Then create a subdirectory called build. -In Linux: -cd build -ccmake .. -or -ccmake -GKDevelop3 .. -(This will set up everything so you can use KDevelop3). - -In Windows: -run CMakeSetup.exe and set the source code directory and where to build the libraries. - -If CMake cannot find Poco, you will see that the variable Poco_INCLUDE_DIR has the value Poco_INCLUDE_DIR-NOTFOUND. Just set this value to the top level direcotry of where the Poco includes are. - -If there is a different version of Poco, you may have to add edit the variables SUFFIX_FOR_INCLUDE_PATH, and SUFFIX_FOR_LIBRARY_PATH adding in the new Poco version in a similar manner to the existing ones in the file PocoConfig.cmake. - -Finally: -In Linux - Either type "make" or if you are using KDevelop, click on the .kdevelop file. -In Windows just use your IDE or nmake if you use nmake. +CMAKE Files contributed by Andrew J. P. Maclean + + +Put the following files in the directory where your source code is: + CMakeLists.txt + PocoConfig.cmake. + +Edit CMakeLists.txt to include your source and header files. The sections of interest are: +# Add any source files here. +SET( EXE_SRCS + "My File.cpp" +) +# Add any include files here. +SET( EXE_INCS + "My File.h" +) + +Then create a subdirectory called build. +In Linux: +cd build +ccmake .. +or +ccmake -GKDevelop3 .. +(This will set up everything so you can use KDevelop3). + +In Windows: +run CMakeSetup.exe and set the source code directory and where to build the libraries. + +If CMake cannot find Poco, you will see that the variable Poco_INCLUDE_DIR has the value Poco_INCLUDE_DIR-NOTFOUND. Just set this value to the top level direcotry of where the Poco includes are. + +If there is a different version of Poco, you may have to add edit the variables SUFFIX_FOR_INCLUDE_PATH, and SUFFIX_FOR_LIBRARY_PATH adding in the new Poco version in a similar manner to the existing ones in the file PocoConfig.cmake. + +Finally: +In Linux + Either type "make" or if you are using KDevelop, click on the .kdevelop file. +In Windows just use your IDE or nmake if you use nmake. diff --git a/contrib/poco-doc.pl b/contrib/poco-doc.pl index e239774a9..35f7c9aa9 100644 --- a/contrib/poco-doc.pl +++ b/contrib/poco-doc.pl @@ -1,47 +1,47 @@ -#!/usr/bin/perl -wi -# -# poco-doc.pl -# -# This script, when run on a POCO header file, moves the documentation -# for classes, methods, etc above their declarations, making the code -# suitable for running through Doxygen, etc. -# -# Author: Caleb Epstein -# -# $Id$ - -use strict; -use warnings; - -my @COMMENT; -my @DECL; - -my $comment_re = qr@^\s*//@; - -while (<>) { - if ((/^\s*(template|class|enum)/ and not /\;\s*$/) or - (/[\(\)](\s*const)?\;$/ and $_ !~ $comment_re)) { - if (scalar @DECL) { - print join ("", @COMMENT) if scalar @COMMENT; - print join ("", @DECL); - } - @DECL = ($_); - @COMMENT = (); - next; - } elsif (m@^\s*///@ and scalar @DECL) { - push (@COMMENT, $_); - } else { - if (scalar @DECL) { - print join ("", @COMMENT) if scalar @COMMENT; - print join ("", @DECL); - @COMMENT = @DECL = (); - } - - # Handle in-line documentation of enum values - if (m@^\s*[^/]@ and m@/// @) { - s@/// @///< @; - } - print; - } -} - +#!/usr/bin/perl -wi +# +# poco-doc.pl +# +# This script, when run on a POCO header file, moves the documentation +# for classes, methods, etc above their declarations, making the code +# suitable for running through Doxygen, etc. +# +# Author: Caleb Epstein +# +# $Id$ + +use strict; +use warnings; + +my @COMMENT; +my @DECL; + +my $comment_re = qr@^\s*//@; + +while (<>) { + if ((/^\s*(template|class|enum)/ and not /\;\s*$/) or + (/[\(\)](\s*const)?\;$/ and $_ !~ $comment_re)) { + if (scalar @DECL) { + print join ("", @COMMENT) if scalar @COMMENT; + print join ("", @DECL); + } + @DECL = ($_); + @COMMENT = (); + next; + } elsif (m@^\s*///@ and scalar @DECL) { + push (@COMMENT, $_); + } else { + if (scalar @DECL) { + print join ("", @COMMENT) if scalar @COMMENT; + print join ("", @DECL); + @COMMENT = @DECL = (); + } + + # Handle in-line documentation of enum values + if (m@^\s*[^/]@ and m@/// @) { + s@/// @///< @; + } + print; + } +} +