research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleaned up Doxygen docs for functions declared in plots.h

Browse source
This commit is contained in:
Ray Speth 2013-04-12 23:07:53 +00:00
parent 1ee0835e9c
commit 97da05bc64
2 changed files with 2 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/cantera/base/plots.h
View file

@ -1,14 +1,12 @@
/**
* @file plots.h
* Contains declarations for utility functions for
* outputing to plotting programs.
* @file plots.h Contains declarations for utility functions for outputing to
* plotting programs.
*/
// Copyright 2001 California Institute of Technology
#ifndef CT_PLOTS_H
#define CT_PLOTS_H
#include "cantera/base/Array.h"
#include "cantera/base/ctexceptions.h"
@ -18,8 +16,6 @@
namespace Cantera
{
//! Write a Plotting file
/*!
* @param fname Output file name
@ -33,7 +29,6 @@ void writePlotFile(const std::string& fname, const std::string& fmt,
const std::string& plotTitle, const std::vector<std::string> &names,
const Array2D& data);
//! Write a Tecplot data file.
/*!
* @param s output stream
@ -46,7 +41,6 @@ void outputTEC(std::ostream& s, const std::string& title,
const std::vector<std::string>& names,
const Array2D& data);
//! Write an Excel spreadsheet in 'csv' form.
/*!
* @param s output stream

29
src/base/plots.cpp
View file

@ -10,15 +10,6 @@ using namespace std;
namespace Cantera
{
// Write a Plotting file
/*
* @param fname Output file name
* @param fmt Either TEC or XL or CSV
* @param plotTitle Title of the plot
* @param names vector of variable names
* @param data N x M data array.
* data(n,m) is the m^th value of the n^th variable.
*/
void writePlotFile(const std::string& fname, const std::string& fmt,
const std::string& plotTitle,
const std::vector<std::string> &names,
@ -41,16 +32,6 @@ void writePlotFile(const std::string& fname, const std::string& fmt,
}
}
// Write a Tecplot data file.
/*
* @param s output stream
* @param title plot title
* @param names vector of variable names
* @param data N x M data array.
* data(n,m) is the m^th value of the n^th variable.
*/
void outputTEC(std::ostream& s, const std::string& title,
const std::vector<std::string>& names,
const Array2D& data)
@ -78,16 +59,6 @@ void outputTEC(std::ostream& s, const std::string& title,
}
}
// Write an Excel spreadsheet in 'csv' form.
/*
* @param s output stream
* @param title plot title
* @param names vector of variable names
* @param data N x M data array.
* data(n,m) is the m^th value of the n^th variable.
*/
void outputExcel(std::ostream& s, const std::string& title,
const std::vector<std::string>& names,
const Array2D& data)