Download Shareware and Freeware Software for Windows, Linux, Macintosh, PDA

line Home  |  About Us  |  Link To Us  |  FAQ  |  Contact

Serving Software Downloads in 976 Categories, Downloaded 29.540.460 Times

Pod::InComments 0.9

  Date Added: February 19, 2010  |  Visits: 458

Pod::InComments

Report Broken Link
Printer Friendly Version


Product Homepage
Download (70 downloads)



Pod::InComments is a Perl extension for extracting POD documentation from comments in config file. SYNOPSIS use Pod::InComments; my $podparser = Pod::InComments->new( comment => ; ); $podparser->ParseFile( $my_config_file ); $podparser->Pod2Hash(); my $helptext = $podparser->Pod4Section( $section , $key ); This module was written to solve the problem of describing numerous parameters in a config file. When you add comments to the config file, it becomes a mess quickly. And no-one will take the time to properly read them. You can not add POD directly. So..... here is Pod::InComments. It was developed when using Config::IniFiles format, so lets take that as the basis. The Config::IniFiles module lets you use config files in the form of the popular windows ini file. That is, they look like [section] param1=some value param2 = another value param3=20.00 ; this is a comment [operating system] preferred=Linux using=Windows XP Pro METHODS new( comment => # ) Constructor of the class. Specify the comment character(s) used in the config file. Defaults to ;. You can use whatever you like here. So #### is valid as well, but requires more typing in the config. ParseFile( $config_file ) Parses the $config_file and extracts all the comment lines. The comment character(s) are stripped of each line. It returns a string with all the POD. Pod2Hash() After parsing a config file, you will need to call this function to convert the POD into a hash. The keys of the hash are the head1 titles. If head2 elements are present, they will be subkeys of the hash. Pod4Section( $section, $param ) Returns the POD belonging to the $section, or to $param of $section. E.g., when your config file looks like: ;=head1 cpu ; ;Specifies cpu settings for normal boxes ;note that these will override factory settings! ; ;=head2 maxload ; ;The maxload setting gives an upperbound on how hard ;the CPU can be pushed. [cpu] maxload=4.0 then doing: my $pod = $podparser->Pod4Section( cpu, maxload ); will give you: The maxload setting gives an upperbound on how hard the CPU can be pushed. SavePod( $file ) Saves the extracted pod to the $file. If you omit a file name, it will append .pod to the config file you parsed and saves to that file. GetPod() Returns the entire POD formatted in text. DisplayPod() Prints the entire extracted POD documentation to STDOUT..

Requirements: No special requirements
Platforms: Linux
Keyword: Comment Config Config File Cpu File Incomments Libraries Maxload Podincomments Programming Section
Users rating: 0/10

License: Freeware Size: 5.12 KB
USER REVIEWS
More Reviews or Write Review


POD::INCOMMENTS RELATED
File Restoration  -  !R-Linux Data Recovery 1.0
R-Linux is a data recovery and undelete utility for Ext2FS (Linux) file system. File recovery after power failure, system crash, virus infection or partition reformation, even for the different file system. Unformat and unerase tool. Creation of...
1.35 MB  
Libraries  -  Perl::Critic::Config 1.061
Perl::Critic::Config is a Perl module to find and load Perl::Critic user-preferences. Perl::Critic::Config takes care of finding and processing user-preferences for Perl::Critic. The Config object defines which Policy modules will be loaded into...
245.76 KB  
Libraries  -  File::Comments 0.07
File::Comments is a Perl module that ecognizes file formats and extracts format-specific comments. SYNOPSIS use File::Comments; my $snoop = File::Comments->new(); # *---------------- # | program.c: # | /* comment */ # | main () {} #...
12.29 KB  
Libraries  -  File::Drawing 0.01
File::Drawing release, revise and retrieve contents to/from a drawing program module. SYNOPSIS ########## # Subroutine interface # use File::Drawing qw( dod_date dod_drawing_number number2pm pm2number obsolete broken backup); $date =...
64.51 KB  
Specialized Tools  -  NPE File Analyzer 1.1.2.1
NPE File Analyzer is a utility that allow users to view and edit 32bit and 64bit Portable Executable (PE) files, such as .EXE .DLL and .SYS files. NPE provides functions for inspection of unknown binaries, you can analyze sections, resources,...
8.11 MB  
Libraries  -  File::DirCompare 0.3
File::DirCompare is a Perl module to compare two directories using callbacks. SYNOPSIS use File::DirCompare; # Simple diff -r --brief replacement use File::Basename; File::DirCompare->compare($dir1, $dir2, sub { my ($a, $b) = @_; if (!...
8.19 KB  
Libraries  -  ConfigReader::Simple 1.25
ConfigReader::Simple is a simple configuration file parser. SYNOPSIS use ConfigReader::Simple; # parse one file $config = ConfigReader::Simple->new("configrc", [qw(Foo Bar Baz Quux)]); # parse multiple files, in order $config =...
11.26 KB  
Libraries  -  File::CounterFile 1.04
File::CounterFile is a persistent counter class. SYNOPSIS use File::CounterFile; $c = File::CounterFile->new("COUNTER", "aa00"); $id = $c->inc; open(F, ">F$id"); This module implements a persistent counter class. Each counter is...
5.12 KB  
Libraries  -  File::LockDir 0.01
File::LockDir is a Perl basic filename-level lock utility. SYNOPSIS use File::LockDir; INTERFACE new Initializes the class. Returns the singleton object. nflock($file, $nap_till, $locker, $lockhost) Locks the supplied filename. Only...
6.14 KB  
Libraries  -  File::MMagic 1.27
File::MMagic is a Perl module to guess file type. SYNOPSIS use File::MMagic; use FileHandle; $mm = new File::MMagic; # use internal magic file # $mm = File::MMagic->new(/etc/magic); # use external magic file # $mm =...
21.5 KB  
NEW DOWNLOADS IN PROGRAMMING, LIBRARIES
Programming  -  FLEX-db Digital Asset Manager 3.0.9
FLEX-db - an enterprise Digital Asset Manager (DAM). It ingests and links metadata with files, creates thumbnails, and processes files using business rules. FLEX-db has a JSP client, Java app server for file input and output and an EJB metadata...
21.57 MB  
Programming  -  Libicom 0.9.0
The libicom library is a character based dynamicly linked library for Linux. It is used to remotely control the Icom IC-R8500 wide band receiver via an RS232 link. All call and return parameters to the control functions are character string based....
20.48 KB  
Programming  -  dotdesktop 0.3
Dotdesktop library provides ability to parse desktop entry file and access the information in a convenient way. Desktop entry file format is defined by freedesktop.org, it is used to describe information about an application such as the name and...
327.68 KB  
Programming  -  Cedalion for Linux 0.2.6
Cedalion is a programming language that allows its users to add new abstractions and define (and use) internal DSLs. Its innovation is in the fact that it uses projectional editing to allow the new abstractions to have no syntactic limitations.
471.04 KB  
Programming  -  libyasl 0.2
Libyasl is a C++ class library to easily realize TCP/UDP/Multicast clientsand servers in IPv4 and IPv6 environments under GNU/Linux systems.
143.36 KB  
Libraries  -  EuGTK 4.8.9
Makes it easy to develop good- looking, fast, cross-platform programs that run on Linux, OS X, and Windows. Euphoria is a very fast interpreted/compiled language with straight-forward syntax. EuGTK allows programming in a clean, object-oriented...
10.68 MB  
Libraries  -  Linux User Group Library Manager 1.0
The LUG Library Manager is a project to help Linux User Groups start their own library. A LUG library is helpful to the community at large because it increases access to information, and gives everyone the opportunity to become more knowledgeable.
5.35 KB  
Libraries  -  Module::MakefilePL::Parse 0.12
Module::MakefilePL::Parse is a Perl module to parse required modules from Makefile.PL. SYNOPSIS use Module::MakefilePL::Parse; open $fh, Makefile.PL; $parser = Module::MakefilePL::Parse->new( join("", ) ); $info = $parser->required;...
8.19 KB  
Libraries  -  sqlpp 0.06
sqlpp Perl package is a SQL preprocessor. sqlpp is a conventional cpp-alike preprocessor taught to understand SQL ( PgSQL, in particular) syntax specificities. In addition to the standard #define/#ifdef/#else/#endif cohort, provides also...
10.24 KB  
Libraries  -  App::SimpleScan::Substitution::Line 2.02
App::SimpleScan::Substitution::Line is a line with optional fixed variable values. SYNOPSIS my $line = App::SimpleScan::Substitution::Line->new(" this "); # Use only this value when substituting " ". $line->fix(substituite =>...
54.27 KB