Esri / arcgis-maps-sdk-toolkit-qt

ArcGIS Maps SDK for Qt Toolkit
Apache License 2.0
132 stars 61 forks source link

Awilliams/qdocs code snippets #468

Closed mrwillyees closed 3 years ago

mrwillyees commented 3 years ago

Here I have enhanced the docs for the tools that were added into the demo apps. I have added an image or gif to the docs and I am extracting snippets of code from the QML version of the demo app. To make it easier I have uploaded the docs and filtered to the one of interest. How do you see it? The gifs might be too much and be annoying, if so I can change it to png (I am missing 2 images at the moment: overview and conversion). https://esriis-my.sharepoint.com/:f:/g/personal/ale11971_esri_com/ElMZ9zdKpiFOqcF3Jq6dFZUBybxqahDr4A5IomsciVwi0g?e=EiILtj To be noted is a new folder inside the /images called docs in which I put all the images and gifs needed to be built into the documentation.

After this, I will need to come up with a solution to also show snippets for the cpp version since it sometime need more work to be done in the cpp backscene, but I am unsure where these snippets should be put because they both point to the same qml files?

anmacdonald commented 3 years ago

I think the documentation looks really good now, thank you for doing this.

Currently there is a QML API bias in the documentation - we might need to explicitly show how to set up a QML API / C++ API in the same documentation.

Also watch out, there has been a mass file rename going on in the Example apps branch - demo_apps is now stale as a branch.

mrwillyees commented 3 years ago

If it is fine how I set up the project by storing the resources under /uitools/images/docs, I will then open a PR for the toolkit build project because I need to add environment variables to set it up correctly. @ldanzinger

mrwillyees commented 3 years ago

PR integrated and moved here. Directly merging into v.next. Closing.