Commit c4ca5c6d authored by Hirsch Singhal's avatar Hirsch Singhal Committed by GitHub
Browse files

Merge pull request #124 from hpsin/master 

Remove html folder, add desktop test data
parents 42da6dc3 dd4475ec

.gitignore

+2 −1
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ 
bld/

[Bb]in/

[Oo]bj/

[Hh]tml/



# Visual Studio 2015 cache/options directory

.vs/

CONTRIBUTING.md

+14 −9
Original line number Diff line number Diff line
@@ -29,15 +29,6 @@ Note: If you wish to work on something that already exists on our backlog, you 
5. Make small and frequent commits that include [tests](https://github.com/Microsoft/WindowsDevicePortalWrapper/blob/master/Testing.md) against mock data or manual tests which can be run against real devices.

6. Make sure that all existing [tests](https://github.com/Microsoft/WindowsDevicePortalWrapper/blob/master/Testing.md) continue to pass.



# Updating code documentation



The Windows Device Portal Wrapper uses [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) to automatically generate code documentation directly from the source code. Any changes to existing or new classes or methods should also update the documentation.



1. Download and install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) (our docs are generated using version 1.8.11).

2. Open a CMD prompt and navigate to your git repository's root directory.

3. Run '\<Doxygen Install Location\>\\doxygen.exe DocConfig.txt'. This will update the files under the html folder relative to the root directory.

4. Include the updated files with your PR.



# Run StyleCop



The Windows Device Portal Wrapper uses the [StyleCop](http://stylecop.codeplex.com) code analysis tool to ensure code consistency and readability. This step is required for the WindowsDevicePortalWrapper folder and is optional (though highly recommended) for test applications.
@@ -80,3 +71,17 @@ Address any review comments, force push to your topic branch, and post a comment 


If the pull request review goes well, a project maintainer will merge your changes. Thank you for helping improve the Windows Device Portal Wrapper!





# Updating code documentation



**For maintainers, since it's a total hack**



The Windows Device Portal Wrapper uses [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) to automatically generate code documentation directly from the source code. Any changes to existing or new classes or methods should also update the documentation.



1. Download and install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html) (our docs are generated using version 1.8.11).

2. Open a CMD prompt and navigate to your git repository's root directory.

3. Switch to the gh-pages branch

4. Run '\<Doxygen Install Location\>\\doxygen.exe DocConfig.txt'. This will update the files under the html folder relative to the root directory.

5. Delete everything but the html folder, then bring the contents of html/ to root.

6. Commit, and PR to the gh-pages branch. 

7. Ponder a better way to do this.

README.md

+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ To start contributing, see [Contributing](https://github.com/Microsoft/WindowsDe 
---

---



For source code documentation, open \<local repository\>\\html\\index.html in a browser.

For source code documentation, see https://Microsoft.github.io/WindowsDevicePortalWrapper



---

---

WindowsDevicePortalWrapper/UnitTestProject/MockData/Desktop/rs1_release/WebSocket_api_resourcemanager_processes_Desktop_rs1_release.dat

0 → 100644
+1 −0

File added.

Preview size limit exceeded, changes collapsed.

WindowsDevicePortalWrapper/UnitTestProject/MockData/Desktop/rs1_release/WebSocket_api_resourcemanager_systemperf_Desktop_rs1_release.dat

0 → 100644
+1 −0
Original line number Diff line number Diff line 
{"AvailablePages" : 3116671, "CommitLimit" : 5689202, "CommittedPages" : 1164481, "CpuLoad" : 50, "IOOtherSpeed" : 2507340, "IOReadSpeed" : 22876276, "IOWriteSpeed" : 613680, "NonPagedPoolPages" : 53776, "PageSize" : 4096, "PagedPoolPages" : 194418, "TotalInstalledInKb" : 16777216, "TotalPages" : 4181874, "GPUData" : {"AvailableAdapters" : [{"DedicatedMemory" : 4271374336, "DedicatedMemoryUsed" : 158380032, "Description" : "AMD Radeon R9 200 Series", "SystemMemory" : 8564477952, "SystemMemoryUsed" : 31318016, "EnginesUtilization" : [0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000]}]}, "NetworkingData" : {"NetworkInBytes" : 0, "NetworkOutBytes" : 0}}
 
 No newline at end of file