DynamoRIO/drmemory

combined doxygen search for DRMF and DR API

Open

#1,609 opened on Nov 28, 2014

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (289 forks)auto 404
Component-DocsComponent-FrameworkMigratedPriority-MediumType-Featurehelp wanted

Repository metrics

Stars
 (2,727 stars)
PR merge metrics
 (PR metrics pending)

Description

From bruen...@google.com on August 17, 2014 11:05:42

split from issue #1056 The current DR + DRMF + Dr. Memory combined package has separate documentation. We've added cross-links to our own custom pages, but the doxygen-generated API docs are completely separate. Furthermore, the top-level search will only search the DR API.

This issue covers a deeper integration, whether through a server-side combined search, a real combined doxygen processing into a single set of docs, or something else.

For now, can we add a note under the search box? I don't see an easy way to do it.

Original issue: http://code.google.com/p/drmemory/issues/detail?id=1609

Contributor guide

Research direction
Investigate combining multiple Doxygen documentation sets into a unified search, possibly by configuring Doxygen to output a single search index or using a server side search that indexes multiple sets.
Tech stack
c
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60