DynamoRIO / DynamoRIO/dynamorio
improve documentation search feature
- Dominant language
- C
- Stars
- 3.2k
- Forks
- 629
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 30
Description
_From [bruen...@google.com](https://code.google.com/u/109494838902877177630/) on January 27, 2014 20:03:16_
The current docs search feature comes straight from doxygen and does a
client-side search with incremental results visible as you type: but only
when you type the starting characters of a match in the reference manual
part of the docs.
We would also like to be able to search the prose parts of the docs, and
more than just prefix matches of the reference manual.
Here are some further options to explore: http://www.stack.nl/~dimitri/doxygen/manual/searching.html
_Original issue: http://code.google.com/p/dynamorio/issues/detail?id=1352_
Contributor guide
Research direction
Start by reading the Doxygen searching manual linked in the issue and inspect how DynamoRIO currently generates its documentation search. Determine how prose search and non-prefix reference-manual matches would fit the existing documentation build. Done means the generated docs can search prose and find reference-manual terms beyond starting-character matches.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100