doxygen.cpp File Reference

This file contains content for the Doxygen-generated documentation that does not fit elsewhere. More...

Go to the source code of this file.

## Detailed Description

This file contains content for the Doxygen-generated documentation that does not fit elsewhere.

Todo
  Add all Frobby code to a FrobbyImpl namespace or some such. Perhaps do it by starting the namespace in stdinc.h, and then adding an include to the bottom of every .cpp file that closes the namespace.

Todo
  Do something to automatically get a Doxygen module of all things not in a Doxygen module. This is a good way to capture those things falling through the cracks by forgetting an ingroup directive. Perhaps do this as for the idea with a namespace above, but instead start a weakgroup in stdinc.h and end it in the bottom include.

Todo
  Go through the documentation in frobby.h and properly Doxify it and use LaTeX. Explain the mathematical background a bit, including definitions of each operation.

Todo
  Add a gradedHilbertPoincareSeries function to library interface which dots each multigraded piece with some given vector, rather than (1,...,1) as for univariateHilbertPointcareSeries.

Todo
  Make a Slice Algorithm Module. Look into this set of classes and remove any smeels. Then document those classes that need it.

Todo
  Add examples sections to library interface documentation. I believe there is a command for this in Doxygen. Especially specify what happens with the zero ideal, the whole ring ideal and when there are no variables.

Todo
  Take a look at MsmSlice::baseCase for the case where the ideal is not simplified. Some of the base cases for the simplified case should apply as well for the non-simplified case, or at least it should be possible to modify them to apply.

Todo
  See if this idea works: If m is a minimal generator of I, and m has maximal exponent in some var, and has the unique minimum exponent in some other var, than we can do an inner split on that other var.

Todo
  Grep for TODO in upper case and add everything found by that as Doxygen todo's.

Definition in file doxygen.cpp.