interface-documentation/bank/bank-account-xml.xml - The generated XML documentation - augmented manually with xml-stylesheet clause.

Lecture 15 - slide 5 : 13 Program 2

<?xml version="1.0"?>
<?xml-stylesheet href="doc.xsl" type="text/xsl"?>
<doc>
    <assembly>
        <name>bank-account</name>
    </assembly>
    <members>
        <member name="T:BankAccount">
            <summary> 
              A simple bank account created as an everyday example
              for the OOP course. Used in particular for demonstrating inheritance.
            </summary>
        </member>
        <member name="M:BankAccount.#ctor(System.String)">
            <summary>
             Construct a bank account from owner. 
             The interestRate is given the default value 0.0.
             The balance is given the default value 0.0.
            </summary>
            <param name = "owner"> The owners name. A string.</param>
        </member>
        <member name="M:BankAccount.#ctor(System.String,System.Double)">
            <summary>
             Construct a bank account from owner, balance, and interestRate.
             The interestRate is given the default value 0.0.
            </summary>
            <param name = "owner"> The owners name </param>
            <param name = "balance"> The initial amount of this account</param>
        </member>
        <member name="M:BankAccount.#ctor(System.String,System.Double,System.Double)">
            <summary>
             Construct a bank account from owner, balance, and interestRate. 
            </summary>
            <param name = "owner"> The owners name </param>
            <param name = "balance"> The initial amount of this account</param>
            <param name = "interestRate"> 
               The interest rate. 
               Annual interet is calculated as balance * interestRate 
            </param>
        </member>
        <member name="M:BankAccount.Withdraw(System.Double)">
            <summary>
              Withdraw an amount of money from the account.
              This decreases the balance of the account.
            </summary>
            <param name = "amount"> 
             The amount of money to withdraw from the account.
             Precondition: Must be non-negative.
            </param>   
        </member>
        <member name="M:BankAccount.Deposit(System.Double)">
            <summary>
              Withdraw an amount of money from the account.
              This increases the balance of the account.
            </summary>
            <param name = "amount"> 
             The amount of money to deposit to the account.
             Precondition: Must be non-negative.
            </param>   
        </member>
        <member name="M:BankAccount.AddInterests">
            <summary>
              Add the annual interest to the account.
              This may increase the current balance of the account.
            </summary>
        </member>
        <member name="M:BankAccount.ToString">
            <summary>
              Return a text string that represents this account
              for output purposes
            </summary>
        </member>
        <member name="P:BankAccount.Balance">
            <summary>
             Returns the current amount of the bank account 
             without affecting the account.
            </summary>
             <value> Accesses the amount of money in the account</value>
        </member>
        <member name="P:BankAccount.InterestRate">
            <summary>
              Return the interest rate of the account
            </summary>
             <value> Accesses the interest rate of the account </value>
        </member>
    </members>
</doc>