pghs975uc
/
infer_clone
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
infer_clone/infer/base.mld

7 lines
186 B
Raw Normal View History Unescape

[doc] add `make doc` target for building html API doc Summary: `make doc` will use `jbuilder` (which in turn uses `odoc`) to generate the documentation for infer's modules. This is useful to browse the APIs of infer and gives a more discoverable place to host more general documentation about infer's internals. Besides the actual plumbing necessary to generate the docs, this diff also - Moves the various infer/src/*/README.md to index.mld files that make it to the generated docs - Fixes some doc comments that would anger `ocamldoc` Closes #435 Reviewed By: mbouaziz Differential Revision: D8314572 fbshipit-source-id: 4a5c70e
7 years ago
{1 Library InferBase}
base and IR build separately, biabduction/ directory Summary: There's actually a nice separation between IR/, base/, istd/, and the rest of infer, so they can be made into separate jbuilder libraries so that the separation remains. This helps make sense of the infer codebase. Also: - move everything biabduction-related out of backend/ and into a new biabduction/ directory. This clarifies the current situation where backend/ contains a mix of analysis-independent code (still there now), and biabduction-specific code (moved to biabduction/). - move everything from base/ that is not infer-specific into istd/, e.g. IList.ml - kill unused `FbTraceCalls` - A couple of files needed to move around to complete the separation of base/ and IR/ Reviewed By: mbouaziz Differential Revision: D7381842 fbshipit-source-id: cd86dea
7 years ago
Utility modules that are somewhat specific to infer, usually because
they depend on Config.ml.
[doc] add `make doc` target for building html API doc Summary: `make doc` will use `jbuilder` (which in turn uses `odoc`) to generate the documentation for infer's modules. This is useful to browse the APIs of infer and gives a more discoverable place to host more general documentation about infer's internals. Besides the actual plumbing necessary to generate the docs, this diff also - Moves the various infer/src/*/README.md to index.mld files that make it to the generated docs - Fixes some doc comments that would anger `ocamldoc` Closes #435 Reviewed By: mbouaziz Differential Revision: D8314572 fbshipit-source-id: 4a5c70e
7 years ago
The entry point of this library is the module:
{!module-InferBase}.