Fix getTarget docs (#1404)

PhotonVision · Aug 29, 2024 · 50ea32c · 50ea32c
1 parent 8c09cd2
commit 50ea32c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/photon-targeting/src/main/java/org/photonvision/targeting/PhotonPipelineResult.java b/photon-targeting/src/main/java/org/photonvision/targeting/PhotonPipelineResult.java
@@ -180,6 +180,8 @@ public boolean hasTargets() {
     /**
      * Returns a copy of the vector of targets.
      *
+     * <p>Returned in the order set by target sort mode.
+     *
      * @return A copy of the vector of targets.
      */
     public List<PhotonTrackedTarget> getTargets() {

diff --git a/photon-targeting/src/main/native/include/photon/targeting/PhotonPipelineResult.h b/photon-targeting/src/main/native/include/photon/targeting/PhotonPipelineResult.h
@@ -120,6 +120,7 @@ class PhotonPipelineResult {
 
   /**
    * Returns a reference to the vector of targets.
+   * <p> Returned in the order set by target sort mode. </p>
    * @return A reference to the vector of targets.
    */
   const std::span<const PhotonTrackedTarget> GetTargets() const {