add some docs
these current names are not great.

I want to change them sometime, but this method is used by outside projects, so I'm just tagging them for now.
ignore intellij files