Giter Club home page Giter Club logo

Comments (8)

eldiener avatar eldiener commented on June 15, 2024

Attached is an example.zip file. Please uncompress this beneath boost/libs to create an "example" library and then run b2 against the jamfile.v2 in the doc directory. In the HTML output you should see in the reference generated that the class in the example namespace gets documented but that the class in the example::detail namespace does not.
example.zip

from b2.

eldiener avatar eldiener commented on June 15, 2024

Do you need any other info to replicate this issue ? I see a "needinfo" tab and I supplied an example.zip for this issue which should allow you to replicate it.

from b2.

grafikrobot avatar grafikrobot commented on June 15, 2024

Sorry.. I haven't gotten a chance to investigate. And I added the needinfo before you added the follow up :-)

from b2.

eldiener avatar eldiener commented on June 15, 2024

What I am seeing is that the example_reference-xml.doxygen does have the XML for the class template in the nested example/detail namespace but that the example_reference-xml.boostbook does not, while each shows the nested namespace itself. Does this mean that the problem is in the xml tool of Boost Build or in the boostbook tool of Boost Build ? Doxygen is definitely producing the correct XML information for the reference.

from b2.

eldiener avatar eldiener commented on June 15, 2024

Could you at least try the example to see if you are getting the same result and therefore confirming the bug ? Not being able to build the correct doxygen documentation with the Boost Build toolsets simply because I am using a nested namespace seems like a pretty serious Boost Build bug to me, when just building the same doxygen documentation using doxygen directly ( through doxywixzard ) works fine as far as any nested namespaces are concerned.

from b2.

grafikrobot avatar grafikrobot commented on June 15, 2024

I replicated the problem. Looking at the generated intermediate files in boost-root/bin.v2/libs/example/doc I observe that:

  • The example_value data is in the doxygen xml.
  • It is not in the generated example_reference-xml.boostbook. Which I presume means it wasn't extracted from doxygen to boostbook.
  • It runs various xsltproc commands to process the generated doxy xml files. Like so:
xslt-xsltproc ../../../bin.v2/libs/b2-issue-18-example/doc/example_reference-xml.doxygen

    XML_CATALOG_FILES="../../../bin.v2/boostbook_catalog.xml"
export XML_CATALOG_FILES
 "xsltproc" --stringparam doxygen.xml.path "/home/grafik/Sync/DevRoots/Boost/develop/bin.v2/libs/b2-issue-18-example/doc/example_reference-xml" --path "../../../bin.v2/libs/b2-issue-18-example/doc" --xinclude -o "../../../bin.v2/libs/b2-issue-18-example/doc/example_reference-xml.doxygen" "/home/grafik/Sync/DevRoots/Boost/develop/tools/boostbook/xsl/doxygen/collect.xsl" "/home/grafik/Sync/DevRoots/Boost/develop/bin.v2/libs/b2-issue-18-example/doc/example_reference-xml/index.xml"

xslt-xsltproc ../../../bin.v2/libs/b2-issue-18-example/doc/example_reference-xml.boostbook

    XML_CATALOG_FILES="../../../bin.v2/boostbook_catalog.xml"
export XML_CATALOG_FILES
 "xsltproc" --stringparam boost.defaults "Boost" --stringparam boost.doxygen.reftitle "Reference" --path "../../../bin.v2/libs/b2-issue-18-example/doc" --xinclude -o "../../../bin.v2/libs/b2-issue-18-example/doc/example_reference-xml.boostbook" "/home/grafik/Sync/DevRoots/Boost/develop/tools/boostbook/xsl/doxygen/doxygen2boostbook.xsl" "../../../bin.v2/libs/b2-issue-18-example/doc/example_reference-xml.doxygen"
  • They look like reasonable command to me. But I know almost nothing about the boostbook xslt. And know absolutely nothing about the doxy processing xslt in there.

You'll have to ask someone who knows about this in the Boost list.

from b2.

eldiener avatar eldiener commented on June 15, 2024

Would you please leave this issue open until I can get someone in Boost who might be able to solve this problem to look at it ? The only name I see associated with BoostBook in the Tools documentation is Douglas Gregor and he has not been active within Boost for a long time now. I will post a message to the developer's mailing list fairly shortly, but I would like to refere to this issue, so It would be nice if it could remain open, even if it is not a Boost Build issue itself, until I can go forward trying to find someone to solve it.

from b2.

grafikrobot avatar grafikrobot commented on June 15, 2024

It's not fair to b2 to leave unrelated issues open. As an alternative you can file an issue in boostbook (https://github.com/boostorg/boostbook/issues) and follow up there. You can refer to this thread over there even if this is closed.

from b2.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.