clean up doxia api and code

Details

  • Type: Task Task
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.1
  • Component/s: Core
  • Labels:
    None

Description

there is a lot of "throws Exception" and uncertainty in the API. It needs a clean up before 1.0

Issue Links

is depended upon by

Bug - A problem which impairs or prevents the functions of the product. DOXIA-51 RtfSink supports only ".ppm" image type in figureGraphics()

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Bug - A problem which impairs or prevents the functions of the product. DOXIA-99 Figures require extension in APT and they should not

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Improvement - An improvement or enhancement to an existing feature or task. DOXIA-75 XhtmlSink#figureCaption() writes an "alt" attribute, but a "title" attribute would also be appropriate

  • Trivial - Cosmetic problem like misspelt words or misaligned text.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
is superceded by

Improvement - An improvement or enhancement to an existing feature or task. DOXIA-208 standardize link/anchor handling: remove usage of StructureSinkUtils

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Brett Porter added a comment -

do a pass over TODO items as well

Show
Brett Porter added a comment - do a pass over TODO items as well
Hide
Permalink
Vincent Siveton added a comment -

a first step, updated the new license headers

Show
Vincent Siveton added a comment - a first step, updated the new license headers
Hide
Permalink
Lukas Theussl added a comment -

Here are a few points that are not clear to me, concerning API:

  • should a sink have to provide a figure extension? see DOXIA-99
  • shouldn't comments be preserved?
  • what is sectionTitle() supposed to do? I haven't seen it used anywhere, is it necessary?

I think we should clarify this before 1.0, maybe in a first beta after alpha-9?

Show
Lukas Theussl added a comment - Here are a few points that are not clear to me, concerning API:
  • should a sink have to provide a figure extension? see DOXIA-99
  • shouldn't comments be preserved?
  • what is sectionTitle() supposed to do? I haven't seen it used anywhere, is it necessary?
I think we should clarify this before 1.0, maybe in a first beta after alpha-9?
Hide
Permalink
Lukas Theussl added a comment -

One more:

Show
Lukas Theussl added a comment - One more:
Hide
Permalink
Vincent Siveton added a comment -

Small discussion about this
http://www.nabble.com/Doxia-core-clean-up-tf4212325.html

Show
Vincent Siveton added a comment - Small discussion about this http://www.nabble.com/Doxia-core-clean-up-tf4212325.html
Hide
Permalink
Lukas Theussl added a comment -

Also rename StructureSink, the name is completely misleading as it is not a sink, and on top contains only apt specific methods, it shouldn't be used by anything else, maybe put it into apt module?

Show
Lukas Theussl added a comment - Also rename StructureSink, the name is completely misleading as it is not a sink, and on top contains only apt specific methods, it shouldn't be used by anything else, maybe put it into apt module?
Hide
Permalink
Vincent Siveton added a comment -

Fixed in r628207. Renamed o.a.m.d.s.StructureSink to o.a.m.d.u.StructureSinkUtils.
Snapshots deployed.

Show
Vincent Siveton added a comment - Fixed in r628207. Renamed o.a.m.d.s.StructureSink to o.a.m.d.u.StructureSinkUtils. Snapshots deployed.
Hide
Permalink
Lukas Theussl added a comment -

I grepped through the code and only found "throws Exception"s in tests, not in the main code. Closing as too generic, please indicate any specific issues if I missed anything.

Show
Lukas Theussl added a comment - I grepped through the code and only found "throws Exception"s in tests, not in the main code. Closing as too generic, please indicate any specific issues if I missed anything.

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Brett Porter
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: