Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for doxygen @note. #87

Merged
merged 1 commit into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ haskell_library(
],
),
src_strip_prefix = "src",
version = "0.0.17",
version = "0.0.18",
visibility = ["//visibility:public"],
deps = [
":ast",
Expand Down
150 changes: 70 additions & 80 deletions cimple.cabal
Original file line number Diff line number Diff line change
@@ -1,57 +1,57 @@
name: cimple
version: 0.0.17
synopsis: Simple C-like programming language
homepage: https://toktok.github.io/
license: GPL-3
license-file: LICENSE
author: Iphigenia Df <iphydf@gmail.com>
maintainer: Iphigenia Df <iphydf@gmail.com>
copyright: Copyright (c) 2016-2022, Iphigenia Df
category: Data
stability: Experimental
cabal-version: >= 1.10
build-type: Simple
name: cimple
version: 0.0.18
synopsis: Simple C-like programming language
homepage: https://toktok.github.io/
license: GPL-3
license-file: LICENSE
author: Iphigenia Df <iphydf@gmail.com>
maintainer: Iphigenia Df <iphydf@gmail.com>
copyright: Copyright (c) 2016-2022, Iphigenia Df
category: Data
stability: Experimental
cabal-version: >=1.10
build-type: Simple
description:
Parser and AST for Cimple, a simple C-like programming language.

source-repository head
type: git
location: https://github.com/TokTok/hs-cimple
type: git
location: https://github.com/TokTok/hs-cimple

library
default-language: Haskell2010
hs-source-dirs:
src
ghc-options:
-Wall
build-tools: alex, happy
hs-source-dirs: src
ghc-options: -Wall
build-tools: alex >=0, happy >=0
exposed-modules:
Language.Cimple
, Language.Cimple.Diagnostics
, Language.Cimple.IO
, Language.Cimple.MapAst
, Language.Cimple.Pretty
, Language.Cimple.Program
, Language.Cimple.TraverseAst
Language.Cimple
Language.Cimple.Diagnostics
Language.Cimple.IO
Language.Cimple.MapAst
Language.Cimple.Pretty
Language.Cimple.Program
Language.Cimple.TraverseAst

other-modules:
Language.Cimple.Annot
, Language.Cimple.Ast
, Language.Cimple.CommentParser
, Language.Cimple.DescribeAst
, Language.Cimple.Flatten
, Language.Cimple.Graph
, Language.Cimple.Lexer
, Language.Cimple.ParseResult
, Language.Cimple.Parser
, Language.Cimple.SemCheck.Includes
, Language.Cimple.Tokens
, Language.Cimple.TranslationUnit
, Language.Cimple.TreeParser
Language.Cimple.Annot
Language.Cimple.Ast
Language.Cimple.CommentParser
Language.Cimple.DescribeAst
Language.Cimple.Flatten
Language.Cimple.Graph
Language.Cimple.Lexer
Language.Cimple.Parser
Language.Cimple.ParseResult
Language.Cimple.SemCheck.Includes
Language.Cimple.Tokens
Language.Cimple.TranslationUnit
Language.Cimple.TreeParser

build-depends:
base < 5
, aeson
aeson
, ansi-wl-pprint
, array
, base <5
, bytestring
, containers
, data-fix
Expand All @@ -65,74 +65,64 @@ library

executable cimplefmt
default-language: Haskell2010
hs-source-dirs:
tools
ghc-options:
-Wall
main-is: cimplefmt.hs
hs-source-dirs: tools
ghc-options: -Wall
main-is: cimplefmt.hs
build-depends:
base < 5
base <5
, bytestring
, cimple
, text

executable dump-ast
default-language: Haskell2010
hs-source-dirs:
tools
ghc-options:
-Wall
main-is: dump-ast.hs
hs-source-dirs: tools
ghc-options: -Wall
main-is: dump-ast.hs
build-depends:
base < 5
base <5
, bytestring
, cimple
, groom
, text

executable dump-tokens
default-language: Haskell2010
hs-source-dirs:
tools
ghc-options:
-Wall
main-is: dump-tokens.hs
hs-source-dirs: tools
ghc-options: -Wall
main-is: dump-tokens.hs
build-depends:
base < 5
base <5
, bytestring
, cimple
, groom
, text

executable include-graph
default-language: Haskell2010
hs-source-dirs:
tools
ghc-options:
-Wall
main-is: include-graph.hs
hs-source-dirs: tools
ghc-options: -Wall
main-is: include-graph.hs
build-depends:
base < 5
base <5
, cimple
, groom

test-suite testsuite
type: exitcode-stdio-1.0
default-language: Haskell2010
hs-source-dirs: test
main-is: testsuite.hs
type: exitcode-stdio-1.0
default-language: Haskell2010
hs-source-dirs: test
main-is: testsuite.hs
other-modules:
Language.Cimple.AstSpec
, Language.Cimple.ParserSpec
, Language.Cimple.PrettySpec
ghc-options:
-Wall
-fno-warn-unused-imports
build-tool-depends:
hspec-discover:hspec-discover
Language.Cimple.AstSpec
Language.Cimple.ParserSpec
Language.Cimple.PrettySpec

ghc-options: -Wall -Wno-unused-imports
build-tool-depends: hspec-discover:hspec-discover
build-depends:
base < 5
, ansi-wl-pprint
ansi-wl-pprint
, base <5
, cimple
, data-fix
, hspec
Expand Down
1 change: 1 addition & 0 deletions src/Language/Cimple/CommentParser.y
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import Language.Cimple.Tokens (LexemeClass (..))
'@deprecated' { L _ CmtCommand "@deprecated" }
'@extends' { L _ CmtCommand "@extends" }
'@implements' { L _ CmtCommand "@implements" }
'@note' { L _ CmtCommand "@note" }
'@param' { L _ CmtCommand "@param" }
'@private' { L _ CmtCommand "@private" }
'@ref' { L _ CmtCommand "@ref" }
Expand Down
1 change: 1 addition & 0 deletions test/Language/Cimple/AstSpec.hs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ViewPatterns #-}
Expand Down