Menu
▾
▴
cpp-netlib-devel
|
From: Glyn M. <gly...@gm...> - 2008-08-11 20:11:59
|
Hi, I created a new subversion branch for documentation. I've added a few a quickbook files and an initial Jamfile (copied without shame from the boost threads library). There are some things that need to be done: 1. We're not an official part of boost, so I don't want to rely too much on this connection (I like the way asio does this). I think it would be a good idea for this project to stand up under its own scrutiny before we decide to submit it for boost review. Maybe if someone could come with a small logo, it could be good ;) 2. I've presented a pretty straightforward documentation template: - Overview - Motivation - Message - Protocols - Acknowledgements This is pretty uncontroversial and should serve us well. Adding an examples section should be trivial (once we have some examples). This will do us for starters, I think. Any comments? Or suggestions? Glyn |
|
From: Jeroen H. <vex...@gm...> - 2010-11-06 18:53:02
|
Hi guys, I've got to start writing documentation for construe_cast, and am wondering if you've got any tips. Is boostbook the way to go, or should I use something else? Regards, Jeroen |
|
From: Dean M. B. <mik...@gm...> - 2010-11-07 02:20:16
|
On Sun, Nov 7, 2010 at 2:52 AM, Jeroen Habraken <vex...@gm...> wrote: > Hi guys, > > I've got to start writing documentation for construe_cast, Cool! :) I'll look forward to that, and eventually porting all the lexical_cast<> stuff in cpp-netlib to construe_cast instead. :D > and am > wondering if you've got any tips. Is boostbook the way to go, or > should I use something else? > Since you intend to make it part of Boost, I would suggest you write the documentation in either RST or Quickbook. Since you're starting from scratch I would suggest you go the RST route. You can look at Sphinx as well as the Boost.Build extensions to support RST processing to turn out HTML documentation. > Regards, HTH -- Dean Michael Berris deanberris.com |
|
From: Dean M. B. <mik...@gm...> - 2008-08-12 03:36:05
|
Hi Glyn! On Tue, Aug 12, 2008 at 4:11 AM, Glyn Matthews <gly...@gm...> wrote: > Hi, > > > I created a new subversion branch for documentation. I've added a few a > quickbook files and an initial Jamfile (copied without shame from the boost > threads library). > > There are some things that need to be done: > > 1. We're not an official part of boost, so I don't want to rely too much on > this connection (I like the way asio does this). I think it would be a good > idea for this project to stand up under its own scrutiny before we decide to > submit it for boost review. Maybe if someone could come with a small logo, > it could be good ;) Sounds like a good idea. I'll ask around for help with regards to a Logo. :) > 2. I've presented a pretty straightforward documentation template: > > - Overview > - Motivation > - Message > - Protocols > - Acknowledgements > > This is pretty uncontroversial and should serve us well. Adding an examples > section should be trivial (once we have some examples). > I just checked in one example of using the HTTP client. I'm going to give another example on using the message framework. :) > This will do us for starters, I think. Any comments? Or suggestions? I like it. If we can generate the docs in HTML and put it up to the sourceforge web space, that would be awesome. :D Looking forward to the documentation! :) -- Dean Michael C. Berris Software Engineer, Friendster, Inc. |
|
From: Glyn M. <gly...@gm...> - 2008-08-12 07:10:35
|
Hi, 2008/8/12 Dean Michael Berris <mik...@gm...> > > I just checked in one example of using the HTTP client. I'm going to > give another example on using the message framework. :) > Yes, I tried it already and it works well :) > > > This will do us for starters, I think. Any comments? Or suggestions? > > I like it. If we can generate the docs in HTML and put it up to the > sourceforge web space, that would be awesome. :D > Not straight away, but I'd like to have it done soon. Maybe I'll have some time at the weekend, and others can feel free to update it as they wish. G |
|
From: Dean M. B. <mik...@gm...> - 2008-08-12 08:55:44
|
On Tue, Aug 12, 2008 at 3:10 PM, Glyn Matthews <gly...@gm...> wrote: > Hi, > > 2008/8/12 Dean Michael Berris <mik...@gm...> >> >> I just checked in one example of using the HTTP client. I'm going to >> give another example on using the message framework. :) > > Yes, I tried it already and it works well :) > Sweet! :D >> >> > This will do us for starters, I think. Any comments? Or suggestions? >> >> I like it. If we can generate the docs in HTML and put it up to the >> sourceforge web space, that would be awesome. :D > > Not straight away, but I'd like to have it done soon. Maybe I'll have some > time at the weekend, and others can feel free to update it as they wish. > Sounds good to me. Come to think of it, now that we've got something pretty usable, maybe we should post something to the Boost mailing list about the progress we've made so far? Or do you still think it's premature? :D Have a good day guys! :) -- Dean Michael C. Berris Software Engineer, Friendster, Inc. |
|
From: Divye K. <div...@gm...> - 2008-08-12 19:48:34
|
Hi, > > > Come to think of it, now that we've got something pretty usable, maybe > we should post something to the Boost mailing list about the progress > we've made so far? Or do you still think it's premature? :D > I would say that its still premature. We need better docs and tests before we inform the boost mailing list. Divye -- An idealist is one who, on noticing that a rose smells better than a cabbage, concludes that it will also make better soup. H. L. Mencken (1880 - 1956) My official web site: http://people.iitr.ernet.in/shp/061305/ Webmaster: http://www.drkapoorsclinic.com Blog: http://divyekapoor.blogspot.com |
|
From: Glyn M. <gly...@gm...> - 2008-08-12 09:13:58
|
2008/8/12 Dean Michael Berris <mik...@gm...> > > Sounds good to me. > > Come to think of it, now that we've got something pretty usable, maybe > we should post something to the Boost mailing list about the progress > we've made so far? Or do you still think it's premature? :D > More motivating examples and more documentation is required, I think. I'd be interested to hear what the criticism of wider audience. Useful examples might include: * Specializing the message type for std::wstring * Specializing the message for custom data structures; * A "better" HTTP example than asio (this is to demonstrate the advantages of this library as an addition to asio) * A proxy example * SSL * A simple example demonstrating the use of web services (we can bundle tinyjson http://blog.beef.de/projects/tinyjson/ along with the examples, I think). > > Have a good day guys! :) > You too, Glyn |
|
From: Dean M. B. <mik...@gm...> - 2008-08-12 09:36:37
|
On Tue, Aug 12, 2008 at 5:13 PM, Glyn Matthews <gly...@gm...> wrote: > 2008/8/12 Dean Michael Berris <mik...@gm...> >> >> Sounds good to me. >> >> Come to think of it, now that we've got something pretty usable, maybe >> we should post something to the Boost mailing list about the progress >> we've made so far? Or do you still think it's premature? :D > > More motivating examples and more documentation is required, I think. I'd > be interested to hear what the criticism of wider audience. > Sounds right to me. :D > Useful examples might include: > * Specializing the message type for std::wstring This should be interesting. There's a special message tag in the tests, it might be nice to make sure that the HTTP client works right with wstrings as well. > * Specializing the message for custom data structures; This one's also a good one. Maybe I can test the vector of pair of strings implementation in an example, and see if I get the correct ordering. > * A "better" HTTP example than asio (this is to demonstrate the advantages > of this library as an addition to asio) I think we already have this? Or do you have something else in mind? :D > * A proxy example This sounds good (but tricky). > * SSL Another interesting thought. Right now I've been hard-coding the use of sockets that aren't HTTPS aware, so that's something that needs to be done still. I'm thinking about it right now and it seems like there's going to be a lot of refactoring to do with the internals of the HTTP client to support HTTPS and maximize the code re-use. And we're not even touching the asynchronous client implementation thought... > * A simple example demonstrating the use of web services (we can bundle > tinyjson http://blog.beef.de/projects/tinyjson/ along with the examples, I > think). > This should be a nice exercise for others to jump in and get their feet wet with the HTTP client. :D -- Dean Michael C. Berris Software Engineer, Friendster, Inc. |
|
From: Glyn M. <gly...@gm...> - 2008-08-12 09:51:06
|
2008/8/12 Dean Michael Berris <mik...@gm...> > On Tue, Aug 12, 2008 at 5:13 PM, Glyn Matthews <gly...@gm...> > wrote: > > > * Specializing the message for custom data structures; > > This one's also a good one. Maybe I can test the vector of pair of > strings implementation in an example, and see if I get the correct > ordering. > Good. I was also thinking of specializing it with unordered containers. > > > * A "better" HTTP example than asio (this is to demonstrate the > advantages > > of this library as an addition to asio) > > I think we already have this? Or do you have something else in mind? :D You added an HTTP client, but I don't see a server that follows the same model. G |
|
From: Dean M. B. <mik...@gm...> - 2008-08-12 10:02:49
|
On Tue, Aug 12, 2008 at 5:51 PM, Glyn Matthews <gly...@gm...> wrote: > > > 2008/8/12 Dean Michael Berris <mik...@gm...> >> >> On Tue, Aug 12, 2008 at 5:13 PM, Glyn Matthews <gly...@gm...> >> wrote: >> >> > * Specializing the message for custom data structures; >> >> This one's also a good one. Maybe I can test the vector of pair of >> strings implementation in an example, and see if I get the correct >> ordering. > > Good. I was also thinking of specializing it with unordered containers. > Might be a good experiment too. I'll see what I can come up with soon. >> >> > * A "better" HTTP example than asio (this is to demonstrate the >> > advantages >> > of this library as an addition to asio) >> >> I think we already have this? Or do you have something else in mind? :D > > You added an HTTP client, but I don't see a server that follows the same > model. > Ah, yes. I'm actually going to talk to the management here at Friendster if they would like to open source the HTTP server I've implemented internally to share with a larger community. Last time we had a similar discussion, it led to the open sourcing of the Memcache++ Client library. That's also the same reason why it took me so long to get on the client side of HTTP for this project. :D I can't share more than that, but I do hope the talks work out. :D -- Dean Michael C. Berris Software Engineer, Friendster, Inc. |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X