move contents of readme into library docs

move contents of readme into library docs

BUG=
R=ajohnsen@google.com

Committed: https://code.google.com/p/dart/source/detail?r=31104

[sethladd, 2013-12-12 07:02:09]

Hi Anders,

I wanted to add a few docs for the http_server library API docs. Can you take a
look? I mostly moved the README contents to the library docs. It's a start.

Thanks

[Anders Johnsen, 2013-12-12 10:23:32]

LGTM, thanks Seth! :)

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/README.md
File pkg/http_server/README.md (right):

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/README.md#ne...
pkg/http_server/README.md:8: imports `dart:io`, it can use this package.
In other words, it can only run where `dart:io` is available.

?

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
File pkg/http_server/lib/http_server.dart (right):

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:5: /// A library for serving HTTP requests
and resources.
Please use

 /**
  *
  */

as I do in the rest of this pkg.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:42: /// ## Virtual directory
This could be moved to the VirtualDirectory class description. Same for
VirtualHost.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:54: /// See
[VirtualDirectory][virtualdirdocs] for more information.
Why as links? It should link to the correct type without. This should also fix
links for /dev and /unstable channels.

[sethladd, 2013-12-12 17:09:31]

Thanks! Addressed your comments.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/README.md
File pkg/http_server/README.md (right):

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/README.md#ne...
pkg/http_server/README.md:8: imports `dart:io`, it can use this package.
It's not clear to new users where dart:io is available, so we wanted to be more
specific.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
File pkg/http_server/lib/http_server.dart (right):

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:5: /// A library for serving HTTP requests
and resources.
Sure thing.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:42: /// ## Virtual directory
Agreed... I'll do that as step 2.

https://codereview.chromium.org/113733002/diff/1/pkg/http_server/lib/http_ser...
pkg/http_server/lib/http_server.dart:54: /// See
[VirtualDirectory][virtualdirdocs] for more information.
Yeah, not sure why. Left over from README? Fixed.

[sethladd, 2013-12-12 17:12:29]

Committed patchset #2 manually as r31104 (presubmit successful).