[Misc] Rework header includes (#311)

* Update header file includes

* Fix includes for lib/rocprofiler-sdk/hip/hip.hpp

* Minor touch ups

* Minor include improvements

* Doxygen tweak

---------

Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>

samples/common/defines.hpp

@@ -21,6 +21,7 @@
 // SOFTWARE.
 
 #pragma once
+
 #define ROCPROFILER_VAR_NAME_COMBINE(X, Y) X##Y
 #define ROCPROFILER_VARIABLE(X, Y)         ROCPROFILER_VAR_NAME_COMBINE(X, Y)