Skip to content

Commit dc8aee4

Browse files
committed
Fixed up commenting to indicate that the noc_routing_algorithm_creator is a factory object
1 parent 14defb5 commit dc8aee4

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

vpr/src/noc/noc_routing_algorithm_creator.h

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22
#define NOC_ROUTING_ALGORITHM_CREATOR
33

44
/**
5-
* @file om)
5+
* @file
66
* @brief This file defines the NocRoutingAlgorithmCreator class, which creates
77
* the routing algorithm that will be used to route packets within the NoC.
88
*
99
* Overview
1010
* ========
11-
* There are a number of different available NoC routing algorithms. The purpose of
12-
* this class is to construct the appropriate routing algorithm based on the user
13-
* specification in the command line. The user identifies a specific routing algorithm
14-
* in the command line by providing a string (which is the name of routing algorithm).
15-
* Then, the appripriate routing algorithm is created here based on the provided
16-
* string.
11+
* There are a number of different available NoC routing algorithms. This class * is a factory object for the NocRouting abstract class. This class constructs
12+
* the appropriate routing algorithm based on the user specification in the
13+
* command line. The user identifies a
14+
* specific routing algorithm in the command line by providing a string
15+
* (which is the name of routing algorithm).
16+
* Then the corresponding routing algorithm is created here based on the
17+
* provided string.
1718
*/
1819

1920
#include <string>
@@ -29,10 +30,10 @@ class NocRoutingAlgorithmCreator {
2930
~NocRoutingAlgorithmCreator() {}
3031

3132
/**
32-
* @brief Given a string that identifies a NoC routing algorithm, this function
33-
* create the corresponding routing algorithm and returns a reference to it. If
34-
* the provided string does not match any available routing algorithms then an
35-
* error is thrown.
33+
* @brief Given a string that identifies a NoC routing algorithm, this
34+
* function creates the corresponding routing algorithm and returns a
35+
* reference to it. If the provided string does not match any
36+
* available routing algorithms then an error is thrown.
3637
*
3738
* @param routing_algorithm_name A user provided string that identifies a
3839
* NoC routing algorithm

0 commit comments

Comments
 (0)