Skip to content

Commit 2c863e6

Browse files
committed
update Enumerator doc
1 parent 04ad28d commit 2c863e6

2 files changed

Lines changed: 1 addition & 15 deletions

File tree

include/casm/container/Enumerator.hh

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,6 @@ namespace CASM {
2929
* - ConfigEnumStrain
3030
* - SuperConfigEnum
3131
*
32-
* Some macros and functions can be used to help implement the required
33-
* members in an Enumerator class. Most enumerators provide iterators that
34-
* dereference as const reference to the object of interest. In some cases it
35-
* may be useful to implement enumerators via a template class using a boolean
36-
* template parameter to specify whether dereferencing iterators results in a
37-
* const or non-const reference to the objects being enumerated. This is what
38-
* the VARIABLECONST macros are intended for.
39-
*
4032
* Enumerators are required to "know" their own name by implementing a
4133
* traits class with 'name' as a const std::string member. For enumerators
4234
* meant to be accessible via the 'casm enum' API, the traits class must also

src/casm/app/enum.cc

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -169,13 +169,7 @@ namespace CASM {
169169

170170
args.log << "Custom enumerator plugins can be added by placing source code \n"
171171
"in the CASM project directory: \n"
172-
" " << primclex->dir().enumerator_plugins() << " \n\n"
173-
174-
"For examples of how to write enumerators see: \n"
175-
" $REPO/include/casm/enumerators \n"
176-
" $REPO/src/casm/enumerators \n"
177-
"where: \n"
178-
" REPO=https://github.com/prisms-center/CASMcode/tree/master \n\n";
172+
" " << primclex->dir().enumerator_plugins() << " \n\n";
179173
}
180174

181175
return 0;

0 commit comments

Comments
 (0)