Menu
▾
▴
[Stdair-svn] SF.net SVN: stdair:[257] trunk/stdair/man
|
From: <den...@us...> - 2010-08-04 18:55:43
|
Revision: 257
http://stdair.svn.sourceforge.net/stdair/?rev=257&view=rev
Author: denis_arnaud
Date: 2010-08-04 18:55:37 +0000 (Wed, 04 Aug 2010)
Log Message:
-----------
[Doc] The man pages are now generated thanks to Doxygen.
Modified Paths:
--------------
trunk/stdair/man/Makefile.am
trunk/stdair/man/doxygen_man.cfg
Added Paths:
-----------
trunk/stdair/man/stdair-config.doc
trunk/stdair/man/stdair.doc
Removed Paths:
-------------
trunk/stdair/man/stdair-config.1
trunk/stdair/man/stdair.3
trunk/stdair/man/stdair_man.doc
Property Changed:
----------------
trunk/stdair/man/
Property changes on: trunk/stdair/man
___________________________________________________________________
Modified: svn:ignore
- .deps
.libs
Makefile.in
Makefile
stdair_man.3
+ .deps
.libs
Makefile.in
Makefile
stdair.1
stdair-config.1
Modified: trunk/stdair/man/Makefile.am
===================================================================
--- trunk/stdair/man/Makefile.am 2010-08-03 08:30:45 UTC (rev 256)
+++ trunk/stdair/man/Makefile.am 2010-08-04 18:55:37 UTC (rev 257)
@@ -2,20 +2,20 @@
#
MAN_SRC_SUFFIX = doc
-MAN_TARGET_SUFFIX = 3
+MAN_TARGET_SUFFIX = 1
+MAN_DIR = man$(MAN_TARGET_SUFFIX)
-man_MANS = stdair.3 stdair-config.1
-MAN_SRC_BASE = stdair_man
-MAN_SRC = $(MAN_SRC_BASE).$(MAN_SRC_SUFFIX)
+MAN_SRC = stdair.doc stdair-config.doc
+man_MANS = $(MAN_SRC:%.doc=%.$(MAN_TARGET_SUFFIX))
-EXTRA_DIST = $(man_MANS) $(MAN_SRC)
+#EXTRA_DIST = $(man_MANS)
#
all-local: man-local
man-local: doxygen_man.cfg $(MAN_SRC)
- doxygen $<; \
- mv -f man3/* . && rmdir man3
+ doxygen $< $(MAN_SRC); \
+ mv -f $(MAN_DIR)/* . && rmdir $(MAN_DIR)
clean-local:
- rm -f $(MAN_SRC_BASE).$(MAN_TARGET_SUFFIX)
+ rm -f $(man_MANS)
Modified: trunk/stdair/man/doxygen_man.cfg
===================================================================
--- trunk/stdair/man/doxygen_man.cfg 2010-08-03 08:30:45 UTC (rev 256)
+++ trunk/stdair/man/doxygen_man.cfg 2010-08-04 18:55:37 UTC (rev 257)
@@ -591,7 +591,7 @@
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
-FILE_PATTERNS = *.1 *.3 *.doc
+FILE_PATTERNS = *.doc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -1158,7 +1158,7 @@
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
-MAN_EXTENSION = .3
+MAN_EXTENSION = .1
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
Deleted: trunk/stdair/man/stdair-config.1
===================================================================
--- trunk/stdair/man/stdair-config.1 2010-08-03 08:30:45 UTC (rev 256)
+++ trunk/stdair/man/stdair-config.1 2010-08-04 18:55:37 UTC (rev 257)
@@ -1,35 +0,0 @@
-.TH StdAir 1 "13 July 2010"
-.SH NAME
-stdair-config - script to get version number and compiler flags of the installed StdAir library
-.SH SYNOPSIS
-.B stdair-config
-[\-\-prefix] [\-\-version] [\-\-libs] [\-\-cflags]
-.SH DESCRIPTION
-.PP
-\fIstdair-config\fP is a tool that is used by configure to determine
-the compiler and linker flags that should be used to compile
-and link programs that use \fIStdAir\fP. It is also used internally
-by the .m4 macros, that are included with \fIStdAir\fP, for GNU autoconf.
-.
-.SH OPTIONS
-\fIstdair-config\fP accepts the following options:
-.TP 8
-.B \-\-version
-Print the currently installed version of \fIStdAir\fP on the standard output.
-.TP 8
-.B \-\-libs
-Print the linker flags that are necessary to link with the \fIStdAir\fP library
-.TP 8
-.B \-\-cflags
-Print the compiler flags that are necessary to compile with the
-\fIStdAir\fP library
-.TP 8
-.B \-\-prefix
-Show the StdAir installation prefix.
-.SH SEE ALSO
-.BR boost-config (1)
-.SH COPYRIGHT
-Copyright \(co 2010 Denis Arnaud
-
-See the COPYING file for more information on the (LGPLv2) license, or
-directly on Internet: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
Copied: trunk/stdair/man/stdair-config.doc (from rev 254, trunk/stdair/man/stdair-config.1)
===================================================================
--- trunk/stdair/man/stdair-config.doc (rev 0)
+++ trunk/stdair/man/stdair-config.doc 2010-08-04 18:55:37 UTC (rev 257)
@@ -0,0 +1,43 @@
+/*!
+
+\page stdair-config Configuration Script for the C++ Standard Airline IT Object Library
+
+\section sec_synopsis SYNOPSIS
+<b>stdair-config</b> <tt>[--prefix] [--version] [--libs] [--cflags]</tt>
+
+\section sec_description DESCRIPTION
+
+\e stdair-config is a tool that is used by configure to determine the
+compiler and linker flags that should be used to compile and link
+programs that use \e StdAir. It is also used internally by the .m4
+macros, that are included with \e StdAir, for GNU autoconf.
+
+\section sec_options OPTIONS
+
+\e stdair-config accepts the following options:
+
+ \b --version<br>
+ Print the currently installed version of StdAir on the standard output.
+
+ \b --libs<br>
+ Print the linker flags that are necessary to link with the StdAir library
+
+ \b --cflags<br>
+ Print the compiler flags that are necessary to compile with the
+ StdAir library
+
+ \b --prefix<br>
+ Show the StdAir installation prefix.
+
+\section sec_see_also SEE ALSO
+ \b stdair-config(1), \b boost-config(1)
+
+\section sec_copyright COPYRIGHT
+
+Copyright © 2009-2010 Denis Arnaud
+
+See the COPYING file for more information on the (LGPLv2) license, or
+directly on Internet:<br>
+http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+
+*/
Deleted: trunk/stdair/man/stdair.3
===================================================================
--- trunk/stdair/man/stdair.3 2010-08-03 08:30:45 UTC (rev 256)
+++ trunk/stdair/man/stdair.3 2010-08-04 18:55:37 UTC (rev 257)
@@ -1,21 +0,0 @@
-.TH StdAir 3 "C++ Standard Airline IT Object Library" "StdAir Team" \" -*- nroff -*-
-.SH NAME
-stdair - C++ Standard Airline IT Object Library
-.SH SYNOPSIS
-#include <stdair/...>
-.SH DESCRIPTION
-The Standard Airline IT (STDAIR) library is a collection of routines
-for travel market simulation. The routines are written from scratch by
-the StdAir team in C++, and present a modern Applications Programming
-Interface (API) for C/C++ programmers, allowing wrappers to be written
-for very high level languages.
-.PP
-The library covers the following areas,
-.TP
-.nf
-.BR
-Architecture
-.fi
-.PP
-Please report any bugs to
-.B https://sourceforge.net/apps/trac/stdair/report
Copied: trunk/stdair/man/stdair.doc (from rev 254, trunk/stdair/man/stdair.3)
===================================================================
--- trunk/stdair/man/stdair.doc (rev 0)
+++ trunk/stdair/man/stdair.doc 2010-08-04 18:55:37 UTC (rev 257)
@@ -0,0 +1,53 @@
+/*!
+\page stdair C++ Standard Airline IT Object Library
+
+\section sec_synopsis SYNOPSIS
+
+\code
+#include <stdair/...>
+\endcode
+
+\section sec_description DESCRIPTION
+
+The Standard Airline IT (STDAIR) library is a collection of routines
+for travel market simulation. The routines are written from scratch by
+the StdAir team in C++, and present a modern Applications Programming
+Interface (API) for C/C++ programmers, allowing wrappers to be written
+for very high level languages.
+
+The library covers the following areas:
+- (Airline) Network-related classes:
+ - Network, ReachableUniverse
+- (Air) Travel-related classes:
+ - TravelSolution, OriginDestination,
+- (Airline) Inventory-related classes:
+ - Inventory, FlightDate, SegmentDate, SegmentCabin, BookingClass,
+ LegDate, LegCabin,
+ Bucket
+- (Airline) Schedule-related classes:
+ - FlightPeriod, SegmentPeriod, LegPeriod
+- (Simulated) Passenger-related demand classes:
+ - DemandStream, BookingRequest
+- (Air) Price-related classes:
+ - YieldStore
+- Architecture
+
+
+\section sec_see_also SEE ALSO
+\b stdair-config(1)
+
+
+\section sec_support SUPPORT
+
+Please report any bugs to https://sourceforge.net/apps/trac/stdair/report
+
+
+\section sec_copyright COPYRIGHT
+
+Copyright © 2009-2010 Denis Arnaud
+
+See the COPYING file for more information on the (LGPLv2) license, or
+directly on Internet:<br>
+http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+
+*/
Deleted: trunk/stdair/man/stdair_man.doc
===================================================================
--- trunk/stdair/man/stdair_man.doc 2010-08-03 08:30:45 UTC (rev 256)
+++ trunk/stdair/man/stdair_man.doc 2010-08-04 18:55:37 UTC (rev 257)
@@ -1,15 +0,0 @@
-/*!
-\page stdair_man StdAir Man Page
-
-\section sec_first First section
-
-Hello, that is the first section.
-Some \b bold words.
-
-\section sec_second Second section
-
-Hello, that is the first section.
-Some \e italic words.
-
-
-*/
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
