Comments (3)
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.
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.
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)
- Variables added from the README documentation HOT 2
- Macros in code are causing parser errors. HOT 6
- Public Api sidebar is not displayed correctly HOT 2
- Download configuration file isn't working HOT 2
- Allow displaying doxygen's html output. HOT 2
- Add Algolia as search provider HOT 6
- Broken link in Home / Versions HOT 3
- Inconsistent punctuation in member function descriptions, and expressions like "i.e." or "e.g." HOT 3
- Missing documentation for two stream inserters
- Request: showing parameter list and return type in function descriptions HOT 5
- Thoughts about using docsforge with existing readthedocs / sphinx documentation HOT 1
- Request: adding EXTRACT_PRIV_VIRTUAL
- Related global functions shown as methods HOT 1
- Public class members other than member functions not shown
- Two enum-related problems
- "Global" language pill switching
- Suppress link generation for commonly used words
- Error generating automatic API documentation when input folder has same name as project
- ERROR!! Your sidebar section Public API has 0 pages HOT 2
- 错误,网站打不开了? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docsforge.