2

Closed

Reference Documentation is Stale

description

Minor

When upgrading from 1.x sdk to 2.0 the uri have changed namespace from
web::http::uri to web::uri. The chm files have not been updated to reflect this.
Closed Tue at 11:27 PM by stevetgates

comments

stevetgates wrote Mar 24 at 4:50 PM

Hi eskech,

Yes you are correct our chm file reference documentation is getting quite out dated at this point. It is from our 1.1 release. Right now we are actually working on seeing what we can do to get our reference documentation hosted somewhere do that you don't have to download the chm files and can more easily review.

You also are correct we moved the URI functionality out of the http namespace because we felt it applies to more protocols like websockets for example. I will update the release notes to reflect this.

FYI I'm changing the issue title to reflect needing to refresh the reference documentation.

Thanks,
Steve

stevetgates wrote Jul 11 at 2:33 AM

I'm still working getting a permanent location for hosting our reference documentation, but in the mean time I've checked in a doxygen configuration file, public_apis_doxyfile, under the Release folder in the development branch. Once you have doxygen installed execute the following to create html reference docs locally:
doxygen public_apis_doxyfile
Steve

stevetgates wrote Jul 14 at 9:52 PM

Ok it is still going to be a while until I get a permanent hosting location. In the mean time you can generate the documentation locally like I mentioned before. I also uploaded the html documentation on to CodePlex, replacing the previously used chm file.

At least now you can easily download up to date html reference documentation.

Steve

stevetgates wrote Tue at 11:27 PM

Ok we now have docs hosted. I've also updated our documentation page to point to them, but they can located at the following. We will update them every release and continue to make improvements:

http://casaserv.github.io/cpprestsdk/namespaces.html