[DOC] Prefix function calls with the package name in examples (#149)

Explicitly states that functions belong to the package and ensures that
there will be no ambiguity with a function of the same name from another
package.
Also remove extra trailing space in the source files producing the man
files.

Fix the paths configuration in the documentation GitHub workflows. They
didn't consider file changes, but only directory changes.

Author: tbouffard

.github/workflows/publish-documentation-pr-preview.yml

@@ -11,8 +11,8 @@ on:
       - '.github/actions/build-documentation-site/**/*'
       - '.github/actions/build-setup/**/*'
       - '.github/workflows/publish-documentation-pr-preview.yml'
-      - 'inst/**'
-      - 'man/**'
+      - 'inst/**/*'
+      - 'man/**/*'
       - '.Rbuildignore'
       - '_pkgdown.yml'
       - 'CONTRIBUTING.md'

.github/workflows/publish-documentation.yml

@@ -9,8 +9,8 @@ on:
       - '.github/actions/build-documentation-site/**/*'
       - '.github/actions/build-setup/**/*'
       - '.github/workflows/publish-documentation.yml'
-      - 'inst/**'
-      - 'man/**'
+      - 'inst/**/*'
+      - 'man/**/*'
       - '.Rbuildignore'
       - '_pkgdown.yml'
       - 'CONTRIBUTING.md'

R/bpmnVisualization.R

@@ -16,7 +16,7 @@
 #'
 #' @name display
 #' @description Display BPMN diagram based on BPMN definition in XML format
-#' 
+#'
 #' @param bpmnXML A file name or xml document or string in BPMN XML format
 #' @param overlays An element or a list of elements to be added to the diagram's existing elements.
 #'      Use overlay function to create an overlay object with content and relative position.
@@ -26,25 +26,25 @@
 #'      Use an explicit element ID for the widget (rather than an automatically
 #'      generated one). Useful if you have other JavaScript that needs to explicitly
 #'      discover and interact with a specific widget instance.
-#' 
-#' @returns A \code{bpmn-visualization} Widget that will intelligently print itself into HTML in a variety of contexts 
+#'
+#' @returns A \code{bpmn-visualization} Widget that will intelligently print itself into HTML in a variety of contexts
 #'      including the R console, within R Markdown documents, and within Shiny output bindings.
-#'      
-#' @examples 
+#'
+#' @examples
 #' # Load the BPMN file
 #' bpmn_file <- system.file("examples/Order_Management.bpmn", package = "bpmnVisualization")
-#' 
+#'
 #' # Display the BPMN diagram
-#' display(bpmn_file, width='auto', height='auto')
-#' 
+#' bpmnVisualization::display(bpmn_file, width='auto', height='auto')
+#'
 #' # Display the BPMN diagram with overlays
 #' overlays <- list(
 #'   create_overlay("start_event_1_1", "42"),
 #'   create_overlay("sequence_flow_1_1", "42"),
 #'   create_overlay("task_1_1", "9")
 #' )
-#' display(bpmn_file, overlays, width='auto', height='auto')
-#' 
+#' bpmnVisualization::display(bpmn_file, overlays, width='auto', height='auto')
+#'
 #' @seealso \code{\link{create_overlay}} to create an overlay
 #'
 #' @import htmlwidgets
@@ -76,14 +76,14 @@ display <- function(
 #' @title Shiny output binding for the \code{bpmn-visualization} HTML widget
 #'
 #' @name bpmnVisualization-shiny-output
-#' @description 
+#' @description
 #' Helper to create output function for using the \code{bpmn-visualization} HTML widget within Shiny applications and interactive Rmd documents.
-#' 
+#'
 #' @param outputId output variable to read from
 #' @param width,height Must be a valid CSS unit (like \code{'100\%'},
 #'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
 #'   string and have \code{'px'} appended.
-#'   
+#'
 #' @returns An output function that enables the use of the \code{bpmn-visualization} widget within Shiny applications.
 #'
 #' @export
@@ -102,11 +102,11 @@ bpmnVisualizationOutput <- function(
 }
 
 #' @title Shiny render binding for the \code{bpmn-visualization} HTML widget
-#' 
+#'
 #' @rdname bpmnVisualization-shiny-render
-#' @description 
+#' @description
 #' Helper to create render function for using the \code{bpmn-visualization} HTML widget within Shiny applications and interactive Rmd documents.
-#' 
+#'
 #' @param expr An expression that generates a \code{bpmn-visualization} HTML widget
 #' @param env The environment in which to evaluate \code{expr}.
 #' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This