Source code for ./tutorials/11-doxygen/average.cpp (via source-highlight)

#include <iostream>

using namespace std;

/**
 * @brief Computes the average of the two passed values.
 *
 * This function computes the average using the standard accepted
 * formula for doing so.
 *
 * @return The average of the two passed values.
 * @param x The first value to average.
 * @param y The second value to average.
 * @todo Need to write acceptance tests for this function
 */

double average (double x, double y) {
    return (x + y) / 2.0;
}

int main() {
    double a, b, c;
    cout << "Enter two different floating point numbers: " << endl;
    cin >> a >> b;
    c = average(a, b);
    cout << "The average of those numbers is " << c << endl;
    return 0;
}