[QuantLibAddin-cvs] QuantLibAddin/Docs/pages index.docs,1.2,1.3

[Eric E. <eri...@us...>]

Update of /cvsroot/quantlibaddin/QuantLibAddin/Docs/pages
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv17652/Docs/pages

Modified Files:
	index.docs 
Log Message:
resolve conflict between multiple index.html files in autogenerated documentation

Index: index.docs
===================================================================
RCS file: /cvsroot/quantlibaddin/QuantLibAddin/Docs/pages/index.docs,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** index.docs	22 Jun 2006 10:56:35 -0000	1.2
--- index.docs	28 Jun 2006 13:27:10 -0000	1.3
***************
*** 1,118 ****
  
! /* 
!  Copyright (C) 2006 Ferdinando Ametrano
!  Copyright (C) 2005 Eric Ehlers
!  Copyright (C) 2005 Plamen Neykov
!   
   This file is part of QuantLib, a free-software/open-source library
   for financial quantitative analysts and developers - http://quantlib.org/
  
!  QuantLib is free software: you can redistribute it and/or modify it under the
!  terms of the QuantLib license.  You should have received a copy of the
!  license along with this program; if not, please email qua...@li...
!  The license is also available online at http://quantlib.org/html/license.html
  
!  This program is distributed in the hope that it will be useful, but WITHOUT
!  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
!  FOR A PARTICULAR PURPOSE.  See the license for more details.
  */
  
! // this file generated automatically by gensrc.py
! // editing this file manually is not recommended
  
- /*! \page index Indices
  \section overview Overview
- functions to construct QuantLib Index objects
- \section functionlist Function List
- \ref qlIndexAddFixing ()\n
- \ref qlIndexAddFixings ()\n
- \ref qlIndexFixing ()\n
- \ref qlIndexName ()\n
- \ref qlXibor ()\n
- \section documentation Function Documentation
- \anchor qlIndexAddFixing \b qlIndexAddFixing
- \code
- void returnValue
- qlIndexAddFixing(
-         string objectID
-         long fixingDate
-         double fixing)
- \endcode
- \par Description:
- add a fixing for the given Index object
- \param objectID id of existing QuantLib Index object
- \param fixingDate fixing date
- \param fixing fixing value
- \return SUCCESS/FAILURE
  
! \anchor qlIndexAddFixings \b qlIndexAddFixings
! \code
! void returnValue
! qlIndexAddFixings(
!         string objectID
!         long fixingDates
!         double fixings)
! \endcode
! \par Description:
! add fixings for the given Index object
! \param objectID id of existing ObjectHandler Index object
! \param fixingDates fixing dates
! \param fixings fixing values
! \return SUCCESS/FAILURE
  
! \anchor qlIndexFixing \b qlIndexFixing
! \code
! any returnValue
! qlIndexFixing(
!         string objectID
!         long fixingDate
!         bool forecastTodaysFixing)
! \endcode
! \par Description:
! retrive the fixing for the given Index object
! \param objectID id of existing QuantLib Index object
! \param fixingDate fixing date(s)
! \param forecastTodaysFixing forecast today's fixing even if the actual fixing is already available
! \return index fixing(s)
  
! \anchor qlIndexName \b qlIndexName
! \code
! string returnValue
! qlIndexName(
!         string objectID)
! \endcode
! \par Description:
! retrive the name for the given Index object
! \param objectID id of existing QuantLib Index object
! \return index name
  
! \anchor qlXibor \b qlXibor
! \code
! string returnValue
! qlXibor(
!         string objectID
!         string IndexName
!         string tenor
!         long fixingDays
!         string Currency
!         string calendar
!         string BDayConvention
!         string dayCounter
!         string termStructureID
!         any permanent)
! \endcode
! \par Description:
! Construct an object of class Xibor and return its id
! \param objectID id of existing QuantLib object
! \param IndexName index name
! \param tenor index tenor (e.g. 2D for two days , 3W for three weeks, 6M for six months, 1Y for one year)
! \param fixingDays fixing days (e.g. 2)
! \param Currency Index Currency
! \param calendar holiday calendar (e.g. TARGET)
! \param BDayConvention business day convention (e.g. ModifiedFollowing)
! \param dayCounter day counter (e.g. Actual360)
! \param termStructureID forecasting term structure
! \param permanent object permanent/nonpermanent
! \return id of newly created object
  
  */
--- 1,66 ----
  
! /*
!  Copyright (C) 2005, 2006 Eric Ehlers
! 
   This file is part of QuantLib, a free-software/open-source library
   for financial quantitative analysts and developers - http://quantlib.org/
  
!  QuantLib is free software developed by the QuantLib Group; you can
!  redistribute it and/or modify it under the terms of the QuantLib License;
!  either version 1.0, or (at your option) any later version.
  
!  This program is distributed in the hope that it will be useful,
!  but WITHOUT ANY WARRANTY; without even the implied warranty of
!  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!  QuantLib License for more details.
! 
!  You should have received a copy of the QuantLib License along with this
!  program; if not, please email qua...@li...
! 
!  The QuantLib License is also available at http://quantlib.org/license.html
!  The members of the QuantLib Group are listed in the QuantLib License
  */
  
! /*! \page index QuantLibAddin
  
  \section overview Overview
  
! %QuantLibAddin implements an interface supporting a subset of QuantLib
! functionality.  Constructor, member and utility functions are defined
! in XML metadata from which a Python application generates source code
! for supported platforms:
  
! \li Microsoft Excel
! \li OpenOffice.Org Calc (Windows and Linux)
! \li Guile
! \li C/C++ (standalone programs)
  
! <div class="center"><img src="images/screenshot.jpg"></div>
  
! The ObjectHandler repository is used to provide an object oriented
! environment even on procedural platforms such as spreadsheets - QuantLib
! objects may be constructed, interrogated, passed as arguments to other
! functions, and destructed.  Polymorphism is supported, for example
! function qlNPV returns the NPV of an Instrument and can be invoked on
! an instance of any derived class - Swap, Bond, etc.
! 
! \section quantlib QuantLib
! 
! %QuantLibAddin shares the QuantLib project structure with regard to
! distribution, licensing, etc., all of which is documented on the main
! QuantLib website:<br>
! http://quantlib.org
! 
! \section introduction Introduction
! 
! Please refer to document \ref installation for instructions on
! building %QuantLibAddin.
! 
! The section \ref functional provides platform-independent,
! end-user documentation of %QuantLibAddin functionality.  
! 
! Additional information is available from the links at the left, 
! if you have a question which is not answered here please send
! email to qua...@li....
  
  */