Documentation Updates (#470)

* Updating installation doc

* updating README

* Addressing Yifan's feedback

* trivial updates

* Added limitation for individual xcc in readme

* Added rocprofv3 page

* README updates

* Updating rocprofv3

* source formatting (clang-format v11) (#538)

Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com>

* Merging documentation team's update

* Update source/docs/installation.md

Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com>

source/include/rocprofiler-sdk/agent.h

@@ -98,7 +98,7 @@ typedef struct rocprofiler_agent_mem_bank_t
 } rocprofiler_agent_mem_bank_t;
 
 /**
- * @brief Agent.
+ * @brief Agent (rocprofiler_agent_t stores the properties of an Agent)
  */
 typedef struct rocprofiler_agent_v0_t
 {

source/include/rocprofiler-sdk/fwd.h

@@ -305,7 +305,9 @@ typedef uint64_t rocprofiler_thread_id_t;
 /**
  * @brief Tracing Operation ID. Depending on the kind, operations can be determined.
  * If the value is equal to zero that means all operations will be considered
- * for tracing.
+ * for tracing. Detailed API tracing operations can be found at associated header file
+ * for that partiular operation. i.e: For ROCProfiler enumeration of HSA AMD Extended API tracing
+ * operations, look at source/include/rocprofiler-sdk/hsa/amd_ext_api_id.h
  */
 typedef uint32_t rocprofiler_tracing_operation_t;
 

source/include/rocprofiler-sdk/registration.h

@@ -35,12 +35,14 @@ ROCPROFILER_EXTERN_C_INIT
  */
 
 /**
- * @brief A pointer to this data structure is provided to the client tool initialization function.
- * The name member can be set by the client to assist with debugging (e.g. rocprofiler cannot start
- * your context because there is a conflicting context started by `<name>` -- at least that is the
- * plan). The handle member is a unique identifer assigned by rocprofiler for the client and the
- * client can store it and pass it to the @ref rocprofiler_client_finalize_t function to force
- * finalization (i.e. deactivate all of it's contexts) for the client.
+ * @brief A client refers to an individual or entity engaged in the configuration of ROCprofiler
+ * services. e.g: any third party tool like PAPI or any internal tool (Omnitrace). A pointer to this
+ * data structure is provided to the client tool initialization function. The name member can be set
+ * by the client to assist with debugging (e.g. rocprofiler cannot start your context because there
+ * is a conflicting context started by `<name>` -- at least that is the plan). The handle member is
+ * a unique identifer assigned by rocprofiler for the client and the client can store it and pass it
+ * to the @ref rocprofiler_client_finalize_t function to force finalization (i.e. deactivate all of
+ * it's contexts) for the client.
  */
 typedef struct
 {