Giter Site home page Giter Site logo

Comments (2)

dbaarda avatar dbaarda commented on September 7, 2024

Other things I've noticed;

  1. Currently .gitattributes marks *.in files as binary so that test data using this extension doesn't get modified on Windows checkouts and break tests. Unfortunately this extension is also used for some cmake template files, including doc/Doxyfile.in. Interestingly src/config.h.cmake doesn't use .in but it probably should since .cmake indicates a cmake config file, not a template. We should rename the test data to use .input instead, and rename src/config.h.cmake to src/config.h.in while we are at it.
  2. In doc/Doxyfile.in there is a setting HAVE_DOT = NO. This turns of all the nice diagrams that Doxygen can generate. Changing this to on makes the docs much more useful. There is also DOT_IMAGE_FORMAT = png, and using svg would probably be better. Also maybe interesting would be INTERACTIVE_SVG = YES to add interactive zoom/pan. Note this requires gaphviz to be installed, so we should update the GitHub action to install it.
  3. There are many files missing the basic \file <foo>.h Doxygen docstring which means they are omitted from the docs. Adding at least all the headers would make navigating the include diagrams much nicer.
  4. Some functions are documented in the *.h file, and some in the *.c file. We should put documentation in the *.h file when we can.

from librsync.

dbaarda avatar dbaarda commented on September 7, 2024

After playing around with markdown docs and github actions in #230 I think maybe replacing \ref links with markdown links may be premature. It seems the version of Doxygen on the github actions ubuntu_latest target suffers from doxygen/doxygen#7595 so markdown links don't quite work as advertised.

There are still several things here that need fixing, so I'm going to put together a PR with the bits still worth doing.

from librsync.

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.