Commit Graph

18 Commits

Author SHA1 Message Date
Kenneth Moreland
3b1bfa0cdd Add reference documentation for Worklet types 2024-01-29 12:26:08 -05:00
Kenneth Moreland
5b8c282e9f Continue transfer of Users' Guide text
These changes complete the using part of the guide.
2023-11-21 10:33:45 -07:00
Kenneth Moreland
3d3b66865f Add option to turn off Doxygen html
The Doxygen html generation takes a lot more time than the xml
generation. If all you want from Doxygen is the xml for the user's
guide, that can be frustrating. Add an option to turn off the xml.
2023-11-21 07:50:04 -07:00
Kenneth Moreland
b80b7e2e71 Add VTK-m User's Guide to source
This is a start of moving the VTK-m User's Guide into the VTK-m source.
This is only the start of the process. There are several goals of this
work.

1. Integrate the documentation into the source code better to better
   keep the code up to date.
2. Move the documentation over to Sphinx so that it can be posted online
   and be more easily linked.
3. Incoporate Doxygen into the guide to keep the documentation
   consistent.
4. Build the user guide examples as part of the VTK-m CI to catch
   compatibility changes quickly.
2023-10-17 11:31:27 -04:00
Robert Maynard
a652f7fe1e Update vtk-m doxygen to generate less warnings 2020-06-01 16:58:32 -04:00
Robert Maynard
d29f5ba376 Update doxyfile to suppress documenting unnecessary components.
We don't want to have our thirdparty libraries doxygen in
the VTK-m doxygen. We also don't want to document internal classes,
and export macros.
2019-09-12 17:29:05 -04:00
nadavi
fbcea82e78 conslidate the license statement 2019-04-17 10:57:13 -06:00
Utkarsh Ayachit
da2e851187 skip fmt and tthread from doxygen 2018-01-26 13:31:10 -05:00
Kenneth Moreland
52060f52c7 Fix many warnings from doxygen
There are still some warnings left:

* Some text in markdown files are incorrectly picked up as
  doxygen commands
* ArrayPortalTransform weirdly inherits from a specialized
  version of itself. It's technically correct C++ code, but
  gives doxygen fits.
2017-09-22 10:29:08 -06:00
Kenneth Moreland
c3a3184d51 Update copyright for Sandia
Sandia National Laboratories recently changed management from the
Sandia Corporation to the National Technology & Engineering Solutions
of Sandia, LLC (NTESS). The copyright statements need to be updated
accordingly.
2017-09-20 15:33:44 -06:00
Robert Maynard
98f8c2e0fe Doxygen now excludes the thrust policy namespace. 2017-07-11 08:48:49 -04:00
Robert Maynard
9cb98f85f0 Doxygen disable showing full paths for files 2017-07-07 11:14:25 -04:00
Robert Maynard
c1f1f3cb68 Add CONTRIBUTING.md to the doxygen page 2017-07-07 11:14:25 -04:00
Robert Maynard
feaa145026 Make VTK-m inheritance diagrams look like VTK's 2017-07-07 11:14:25 -04:00
Robert Maynard
3f42642d24 Use Markdown readme as mainpage for doxygen. 2017-07-07 11:14:25 -04:00
Robert Maynard
c09e88d214 Improve the overall doxygen content for vtk-m. 2017-07-07 11:14:25 -04:00
Robert Maynard
ccc8455e1d First initial pass at cleaning up the doxygen generation for vtkm 2017-07-07 11:14:25 -04:00
Sujin Philip
1a9e8d1e3d Initial support for generating documentation using Doxygen 2015-07-17 15:35:59 -04:00