Skip to content
A Simple C++ Reference Viewer
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
README
cppref.el

README

;;; cppref.el --- A Simple C++ Reference Viewer

;; Copyright (C) 2009 Kentaro Kuribayashi

;; Author: Kentaro Kuribayashi, <kentarok@gmail.com>
;; Keywords: C++

;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; * Description

;; cppref.el is a port of Perl's cppref command, a simple C++
;; reference viewer working on a terminal.

;; * Usage
;;
;; cppref.el requires cl installed in advance. So, add
;; the lines below into your .emacs:
;;
;;   (require 'cppref)
;;
;; File viewing is handled by browse-url. You can customize the browser
;; with the option variable browse-url-browser-function.
;;
;; Althogh cppref.el automatically find out the place of
;; documentation, if you want to put your the directory at some other
;; place, you must add one more line like below:
;;
;;   (setq cppref-doc-dir "/path/to/dir") ;; doesn't end with "/"
;;
;; Then run `cppref' command and type like "vector::begin",
;; "io::fopen", or so.

;;; Acknowledment:

;; cppref.el is Emacs version of Kazuho Oku's cppref command
;; http://search.cpan.org/dist/cppref/

;; The documents are from http://www.cppreference.com/ (under Creative
;; Commons Attribution 3.0 license).
You can’t perform that action at this time.