Skip to content

Fix DocC warnings #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Fix DocC warnings #968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Sources/ArcGISToolkit/Documentation.docc/AugmentedReality.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ reality experiences for common AR patterns including Flyover, TableTop, and Worl
`FlyoverSceneView` provides an augmented reality flyover experience that allows you to
explore a scene using your device as a window into the virtual world. The experience begins
with the ArcGIS Scene's camera positioned over an area of interest. Walk around and reorient
the device to focus on specific content in the scene. To learn more about using the ``FlyoverSceneView`` see the <doc:FlyoverSceneViewTutorial>.
the device to focus on specific content in the scene. To learn more see the <doc:FlyoverSceneViewTutorial>.
Copy link
Contributor

@zkline101 zkline101 Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that we should make this change because these symbol links are helpful on other platforms. We host the iOS docC archive, not the mac catalyst docC archive so these warnings aren't really valid for our use case. I remember reading through this AR doc and I found these links helpful. Thoughts?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had suggested to @des12437 that she remove them because component name is already provided via the paragraph headers.

Also it looks like these links aren't live on the current published web version so I'm not sure what the targeted platform is when the docs are built for hosting:
Screenshot 2024-11-14 at 2 30 28 PM

Hopefully DocC supports compiler directives of some sort eventually.

@mhdostal thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had suggested to @des12437 that she remove them because the component name is already provided via the paragraph headers.

I remember when I was reading this that I would read each paragraph then I would want to look at the API and there was no convenient way to get there other than search the type. Not a huge deal I just think the symbol links are a nice addition.

Also it looks like these links aren't live on the current published web version so I'm not sure what the targeted platform is when the docs are built for hosting:

Weird. I knew the SDK was iOS but I just assumed the same here, I can double-check this because now I am curious.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can double-check this because now I am curious.

Yeah looks like it is using the iOS DocC archive, hmm weird.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I know why. The symbol links were added in 200.6 and the doc you are looking at is for 200.5.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just wish there was a way to eliminate all possible warnings.

I agree with that 😮‍💨

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can revert these changes for now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully DocC supports compiler directives of some sort eventually.

Maybe we can log an issue like swiftlang/swift-docc#255 but specify our need to allow skipping certain symbols for visionOS.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can log an issue like swiftlang/swift-docc#255 but specify our need to allow skipping certain symbols for visionOS.

Good idea @yo1995. I can log an issue.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

swiftlang/swift-docc#1098


**TableTopSceneView**

`TableTopSceneView` provides an augmented reality table top experience where ArcGIS Scene content
is anchored to a physical surface. To learn more about using the ``TableTopSceneView`` see the <doc:TableTopSceneViewTutorial>.
is anchored to a physical surface. To learn more see the <doc:TableTopSceneViewTutorial>.

**WorldScaleSceneView**

`WorldScaleSceneView` provides an augmented reality world scale experience where ArcGIS Scene content
is integrated with the real world. To learn more about using the ``WorldScaleSceneView`` see the <doc:WorldScaleSceneViewTutorial>.
is integrated with the real world. To learn more see the <doc:WorldScaleSceneViewTutorial>.

###### Requirements
* Set the following properties in the app's **info.plist**:
Expand Down