Skip to content

Commit

Permalink
Fixup documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nrkramer committed May 6, 2023
1 parent 72508dc commit 102abf1
Showing 1 changed file with 12 additions and 28 deletions.
40 changes: 12 additions & 28 deletions include/Graph/Graph.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -459,21 +459,6 @@ class Graph {
*/
virtual const std::vector<Node<T>> graph_slicing(const Node<T> &start) const;

/**
* \brief
* This function write the graph in an output file
* Note: No Thread Safe
*
* @param format The Output format of the file
* @param workingDir The path to the directory in which will be placed the
* output file
* @param OFileName The Output File Name ( )
* @param compress Indicates if the output will be compressed
* @param writeNodeFeat Indicates if export also Node Features
* @param writeEdgeWeight Indicates if export also Edge Weights
* @return 0 if all OK, else return a negative value
*/

/**
* @brief Function runs the Dial algorithm (Optimized Dijkstra for small
* range weights) for some source node and target node in the graph and
Expand Down Expand Up @@ -501,17 +486,16 @@ class Graph {

/**
* \brief
* This function write the graph in an output file
* Note: No Thread Safe
* This function writes the graph to an output file
* Note: Not threadsafe
*
* @param format The Output format of the file
* @param workingDir The path to the directory in which is placed the Output
* file
* @param OFileName The Output File Name ( )
* @param format The output format of the file
* @param workingDir The parent directory of the output file
* @param OFileName The output filename
* @param compress Enables compression (requires zlib)
* @param writeNodeFeat Indicates if export also Node Features
* @param writeEdgeWeight Indicates if export also Edge Weights
* @return 0 if all OK, else return a negative value
* @return 0 if OK, else return a negative value
*/
virtual int writeToFile(
InputOutputFormat format = InputOutputFormat::STANDARD_CSV,
Expand All @@ -521,17 +505,17 @@ class Graph {

/**
* \brief
* This function read the graph from an input file
* Note: No Thread Safe
* This function reads the graph from an input file
* Note: Not threadsafe
*
* @param format The Input format of the file
* @param workingDir The path to the directory in which is placed the Input
* @param format The input format of the file
* @param workingDir The parent directory of the input
* file
* @param OFileName The Input File Name ( )
* @param OFileName The input filename
* @param compress Enables compression (requires zlib)
* @param readNodeFeat Indicates if import also Node Features
* @param readEdgeWeight Indicates if import also Edge Weights
* @return 0 if all OK, else return a negative value
* @return 0 if OK, else return a negative value
*/
virtual int readFromFile(
InputOutputFormat format = InputOutputFormat::STANDARD_CSV,
Expand Down

0 comments on commit 102abf1

Please sign in to comment.