[PM] Add proper documentation for the ModulePassManager and
authorChandler Carruth <chandlerc@gmail.com>
Fri, 2 Jan 2015 23:34:39 +0000 (23:34 +0000)
committerChandler Carruth <chandlerc@gmail.com>
Fri, 2 Jan 2015 23:34:39 +0000 (23:34 +0000)
commitb920271dd262924109d640544db67b93c4beb663
tree84a4eec0fe7758ed74f002656c60cceb839df6f7
parentfd548d55ac4046a7cb4454d4e91ca22c693e67a3
[PM] Add proper documentation for the ModulePassManager and
FunctionPassManager. These never got documented, likely due to the
clutter of this header file. This fixes another problem people noticed
when they started trying to use the new pass manager.

I've also used this to document the aspirational constraints I would
like to hold passes to. I don't really have a better place to document
such things at this point, but eventually will probably create a proper
.rst file and page for the LLVM pass infrastructure that carries such
high-level concerns.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@225097 91177308-0d34-0410-b5e6-96231b3b80d8
include/llvm/IR/PassManager.h