Giter Site home page Giter Site logo

Comments (3)

erez-o avatar erez-o commented on July 19, 2024

I don't see in doxygen's documentation regarding autolink a % .

Currently, this doxygen flag is always enabled when running docsforge.

On top of that, Docsforge has a more greedy auto-linking implementation that can be disabled all together with autolink:false, or it can be limited by excluding a list of words using autolink_exclude

I strongly suggest enabling autolink:true and using autolink_exclude to tweak it, and if it's needed, I'll add autolink_exclude_pattern and autolink_include_pattern that will let users exclude/include any regex pattern.

autolink:false would also disable any links in markdown pages, mentioned in, or source browsing, so I really don't recommend it.

I do maintain a list of common english words excluded by default for all packages. For example, if you have a function named do, not every do found will be autolinked, but only if followed by something that resembles a C/C++ method - do(...) or do<...>

from docsforge.

gennaroprota avatar gennaroprota commented on July 19, 2024

The relevant documentation is here. It says:

If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a % in front of the word.

Yes, I currently have autolink: true and autolink_exclude (with just one word in it, for now).

About do, that's a keyword in C++ (and in several other languages I know of), so I can't have a function with that name :-)

from docsforge.

erez-o avatar erez-o commented on July 19, 2024

Yeah, forgot that do is a bad example :) the list of excluded common words has around 60,000 words so any other example word would do.

Thanks for finding the relevant documentation, I didn't know about it.
I don't plan on supporting it when autolink:true.

Maybe it's a personal preference, but I don't think it's a good approach to add % in your code as a way of solving it because 99% of programmers reading the code (and not the html) won't understand what it means.

from docsforge.

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.