Thomas Guest wrote:I can see more clearly how the second model (presented by JoÃo) would work, but I don't like adding the snippet delimiters in comments. It cuts across the Doxygen comment processing. Remember also that the comment syntax will be different for different source modes. That said, James Fowler has already gone some way towards implementing inclusion of snippets.
I don't see why the delimiters would cut through Doxygen comment processing. But this is still a proposal so we may agree on a better syntax.
I agree. When Joao and I had the chat, I wasn't quite anxious about the include snippet proposal. I didn't have a strong case against it at the time and thought that both solutions are orthogonal anyway. Now, it seems that you provided a strong case against it: that 1) Qbk needs to know something about the target language and each markup syntax will be different for different langauges. This is unwieldy.
As David pointed out, we already know what comments look like from the syntax highlighter stuff.
I'll add that when I used {} in the quickbook comment before, I only meant to point out the limitations of my scheme with current quickbook comments. Your off-list proposal for alternate comments in quickbook nicely solves that.
We can also extend the syntax highlighter stuff to specify how snippet delimiters look like for each source type if there is the need.
2) I too do not like special tagged comments in my source code. In that sense, I am not quite fond of Doxygen, in fact.
FWIW, we may as well use:
// snippet id
... code to be included ...
// end snippet
We don't really need an awkward syntax.
I thought it'd be a good idea for the tags to be explicitly associated with quickbook. The quickbook-like syntax in my proposal was also intended to leave the door open for a doxygen-like doc-extraction utility in quickbook.
JoÃo
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
